Docs IA reorg + mdBook setup + changelog migration#4
Conversation
📝 WalkthroughWalkthroughDocumentation repository reorganized to use mdBook for site generation, with removal of two legacy documentation files (upstream patch list and Contract System v2) and introduction of structured documentation directories. Configuration added for mdBook with build recipes. Multiple documentation links updated to reflect new directory hierarchy. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/README.md`:
- Around line 7-8: Replace the machine-specific absolute path
'/Users/robertguss/Projects/programming_tiger_style/book.toml' in the README
text with a repo-relative path (e.g., 'book.toml' or './book.toml') so other
contributors aren’t misled; update the sentence "This folder is the mdBook
source (`/Users/robertguss/Projects/programming_tiger_style/book.toml`)." to
reference the relative path and keep the rest of the instructions (Run `just
book-serve` ...) unchanged.
🧹 Nitpick comments (1)
justfile (1)
76-86: LGTM!The mdBook recipes are clean and follow the existing justfile patterns. They integrate well with the new
book.tomlconfiguration.Consider adding a comment noting that
book-installshould be run first if mdbook is not already installed, or optionally make it a soft dependency:# Build mdBook docs to docs/book (run book-install first if mdbook is missing). book-build: mdbook build
| This folder is the mdBook source (`/Users/robertguss/Projects/programming_tiger_style/book.toml`). | ||
| Run `just book-serve` from the repository root for a local docs site. |
There was a problem hiding this comment.
Avoid machine-specific absolute path in docs.
/Users/robertguss/.../book.toml is local-only and will mislead other contributors. Use a repo-relative path instead.
✅ Suggested fix
-This folder is the mdBook source (`/Users/robertguss/Projects/programming_tiger_style/book.toml`).
+This folder is the mdBook source (`book.toml` at the repository root).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| This folder is the mdBook source (`/Users/robertguss/Projects/programming_tiger_style/book.toml`). | |
| Run `just book-serve` from the repository root for a local docs site. | |
| This folder is the mdBook source (`book.toml` at the repository root). | |
| Run `just book-serve` from the repository root for a local docs site. |
🤖 Prompt for AI Agents
In `@docs/README.md` around lines 7 - 8, Replace the machine-specific absolute
path '/Users/robertguss/Projects/programming_tiger_style/book.toml' in the
README text with a repo-relative path (e.g., 'book.toml' or './book.toml') so
other contributors aren’t misled; update the sentence "This folder is the mdBook
source (`/Users/robertguss/Projects/programming_tiger_style/book.toml`)." to
reference the relative path and keep the rest of the instructions (Run `just
book-serve` ...) unchanged.
Objective
Create a maintainable documentation information architecture, add mdBook navigation/build support, and preserve historical context in a single changelog so legacy planning files can be retired.
Risk Tier
Scope
docs/reorganization, link updates, mdBook scaffolding (book.toml,docs/SUMMARY.md), changelog creation, retirement of two legacy root markdown files, and docs-only path classification update inscripts/validate_tdd_cycle.sh.Red
rg -n "09-upstream-tiger-style-v1\.1-patch-list\.md|CONTRACT_SYSTEM_V2\.md"Green
scripts/validate_tdd_cycle.sh --base origin/main --allow-empty-range;bash -n scripts/validate_tdd_cycle.sh;just book-buildorigin/main..HEAD, script syntax check passed, and mdBook build succeeded.Refactor
just book-build;scripts/validate_tdd_cycle.sh --base origin/main --allow-empty-rangeInvariants
Security Impact
No new permissions, secrets handling, network paths, or trust-boundary behavior introduced.
Performance Impact
No runtime performance impact; only docs build/navigation structure changed.
Assumptions
CHANGELOG.mdentries.Open Questions
Rollback Plan
CHANGELOG.mdbut back out docs path migration independently.Validation Commands
scripts/validate_tdd_cycle.sh --base origin/main --allow-empty-rangebash -n scripts/validate_tdd_cycle.shjust book-buildSummary by CodeRabbit
New Features
Documentation
Chores