Repository navigation
Add onboarding guide and Phase 8 documentation updates - #7
Merged
Merged
Conversation
A curated pointer at the canonical docs (plan, phases, ADRs, AGENTS.md) and a code reading order, not a duplicate of them. Sections: - What this app does (one paragraph product framing) - 30-minute orientation (read-order table) - Architecture in one diagram - Code reading order (8 numbered steps with file links) - How a request flows end-to-end (Razor → Calculator → Meal) - Conventions you must respect (non-negotiable subset) - Anti-patterns (do NOT reintroduce) + table from AGENTS.md - Local commands (build/test/coverage) - How to make your first change (add a Range meal walkthrough) - Where to get help (doc → question mapping) All 26 source-file links and 11 doc links resolve to real files. Build clean: 0 warnings, 0 errors (Release).
Phase 8 (rename Backup/ to OriginalSource/, commit 5ca5ecc) shipped without a phase doc. This commit retroactively adds the per-phase deliverable so the docs/phases/ folder is complete and the docs/phases/README.md status table includes Phase 8. Changes: - New docs/phases/phase-8-rename-original-source.md following the established phase template (Goal / What shipped / Decisions / Validation / Anti-patterns). - docs/phases/README.md gains row 8 in the status table and a Phase 8 entry in the per-phase file list. Also flips four pre-existing ⏳ markers (phases 1-4) to ✅ to match the status column above. The new phase doc calls out the apparent '+ 6 new tests' figure in the original Phase 8 commit message as a copy-paste error from the Phase 7 message; total facts before and after Phase 8 is 118. Per ADR 0003 docs/plan.md is locked; Phase 8 is intentionally NOT added to its branch map. Build clean: 0 warnings, 0 errors (Release). No production code or test changes; coverage and test count unchanged from Phase 7.
docs: onboarding guide + Phase 8 phase doc (retroactive)
Pre-renders six Mermaid diagrams from docs/DIAGRAMS.md as PNG files under docs/diagrams/ and links them from the README, onboarding, slides, elevator-pitch, and LinkedIn pitch. The PNGs are sized for LinkedIns 1200x627 card slot and slide decks. Sources (.mmd) are kept alongside the PNGs so future edits can re-render with one command. - README: embed 01-architecture.png next to the layering block - docs/SLIDES.md: pin specific PNGs as second-screen props on slides 3/5/12/15/17 - docs/ELEVATOR-PITCH.md: gap-fillers now point at PNGs, not just Mermaid sources - docs/LINKEDIN.md: new "Visual assets for the post" table - docs/onboarding.md: 2b reading-order row + architecture PNG callout - docs/README.md: new diagrams/ row in the docs hub - docs/DIAGRAMS.md: "Pre-rendered PNGs" section + re-render command ~630 KB of new content; no production code touched. Co-authored-by: CookingTime contributor <contributor@cookingtime.local>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.