Skip to content

Move the developer guide to docs/development.md - #7

Merged
mj-hahn merged 1 commit into
mainfrom
docs/development-guide
Nov 10, 2026
Merged

mj-hahn merged 1 commit into
mainfrom
docs/development-guide

Conversation

@mj-hahn

@mj-hahn mj-hahn commented Nov 10, 2026

Copy link
Copy Markdown
Owner

Change

  • The README's Development section moved to docs/development.md: the code layout, checks, running the page without Kiro Crew, and every "Prove …" section. The text is unchanged, apart from one level less of heading and linked paths.
  • The README keeps a short Development section with a link and the two check commands. It drops from 393 to 252 lines.
  • The screenshot note links to docs/development.md#run-the-page-without-kiro-crew.
  • docs/backlog.md:
    • points at the new Checks section;
    • says the repo is public and main needs checks to pass;
    • updates the test counts.
  • A new contract test checks that every relative link and anchor in the README, the guide and the backlog lands on a real file and heading.

User impact

  • The README reads as a user's page. Contributors get a page of their own.

Risk

  • Docs only. One-way door: no.

Rollback

Revert the merge.

Evidence

  • Contract tests: 28 OK, including the new link test.

🤖 Generated with Claude Code

The README keeps a Development pointer and the two check commands. The backlog points at the new Checks section and says the repo is public. A contract test now checks every relative link and anchor in the README, the guide and the backlog.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mj-hahn
mj-hahn merged commit f5397df into main Nov 10, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant