Reorganize docs: archive planning, add ADRs, update implementation status - #208
Merged
Conversation
Captures 15 findings from a thorough code review, organized by severity: - 2 critical bugs (dart:io web breakage, sequential API fetching) - 3 high-priority bugs (festival URL sync, route validation, mutable state) - 3 medium bugs (key prefix matching, UTF-8 decoding, context safety) - 4 high usability issues (About nav, filter clearing, favorites scoping) - 4 medium usability issues (raw IDs, search debounce, a11y hints) https://claude.ai/code/session_01L2cfZXThqbJdZmozMDr4DQ
Code review findings (15 issues): - 3 critical bugs: dart:io web breakage, sequential API fetching, festival URL sync - 5 high-priority: route validation, mutable state, filter clearing, About nav, favorites scoping - 7 medium: key prefix matching, UTF-8 decoding, raw IDs, search debounce, a11y hints, context safety, availability label Doc reorganization: - Move todos.md -> docs/todos.md - Move CI_REVIEW.md -> docs/processes/ci-review.md - Move CI_IMPROVEMENTS_SUMMARY.md -> docs/processes/ci-improvements-summary.md - Move CI_NAMING_RECOMMENDATIONS.md -> docs/processes/ci-naming-recommendations.md - Move SAFE_CACHE_STRATEGY.md -> docs/processes/safe-cache-strategy.md - Update docs/README.md with new files and index - Fix internal cross-references in ci-improvements-summary.md https://claude.ai/code/session_01L2cfZXThqbJdZmozMDr4DQ
New ADRs:
- 0004: Path-based URL strategy (extracted from deep-linking planning docs)
- 0005: E2E testing strategy (Playwright for URL smoke tests, not Patrol)
Fixes:
- accessibility.md: Remove false "NOT IMPLEMENTED" claim (53+ Semantics
widgets exist with 9 dedicated tests)
- ci-cd.md: Fix workflow name ("CI" not "Flutter App CI/CD"), coverage
threshold (70% not 25%)
- flutter-web-testing.md: Fix Semantics widget count (53+ not 24)
Moved to correct locations:
- docs/navigation.md -> docs/code/navigation.md
- docs/ui-components.md -> docs/code/ui-components.md
Archived superseded docs:
- deep-linking/ planning docs -> planning/archive/deep-linking/
(Phase 1 complete, decisions captured in ADR 0004)
- patrol-firebase-testing/ -> planning/archive/patrol-firebase-testing/
(not implemented, decision captured in ADR 0005)
- CI review docs -> planning/archive/ci-review/
(implemented, decisions captured in ADRs 0001-0003)
Updated docs/README.md to reflect new structure.
https://claude.ai/code/session_01L2cfZXThqbJdZmozMDr4DQ
- README.md: Remove references to archived patrol-firebase-testing docs, link to ADR 0005 instead - AGENTS.md: Fix API doc paths (docs/api/ -> docs/code/api/) https://claude.ai/code/session_01L2cfZXThqbJdZmozMDr4DQ
- .gitignore: Split merged line so screenshots/ is properly ignored and !test/*.mocks.dart exception works correctly - web/index.html: Remove maximum-scale=1.0 and user-scalable=no which blocked pinch-to-zoom (WCAG 2.1 AA failure, SC 1.4.4) - web/manifest.json: Add id field for stable PWA identity https://claude.ai/code/session_01L2cfZXThqbJdZmozMDr4DQ
Contributor
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes and updates the project documentation by moving completed planning material into an archive, extracting key decisions into ADRs, and refreshing “current state” docs (accessibility, routing/testing, CI/CD). It also includes a couple of small web-platform metadata tweaks.
Changes:
- Added ADRs for deep-linking URL strategy and E2E testing strategy; archived prior planning/review docs under
docs/planning/archive/. - Updated current docs (docs index, accessibility status, CI/CD coverage requirements, tooling/testing notes, TODO tracking).
- Minor web changes: added PWA manifest
idand relaxed the viewport meta tag to allow user scaling.
Reviewed changes
Copilot reviewed 13 out of 31 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| web/manifest.json | Adds a PWA id field to stabilize install identity. |
| web/index.html | Updates viewport meta tag to improve zoom/accessibility behavior. |
| docs/tooling/flutter-web-testing.md | Updates Semantics widget count and links to the accessibility inventory doc. |
| docs/todos.md | Expands/refreshes the tracked bug + improvement backlog and updates last-modified date. |
| docs/processes/safe-cache-strategy.md | Adds a new guide describing “safe” GitHub Actions caching patterns. |
| docs/processes/ci-cd.md | Renames the main workflow to “CI” and updates documented coverage minimum to 70%. |
| docs/planning/archive/patrol-firebase-testing/summary.md | Archives Patrol/Firebase Test Lab evaluation summary. |
| docs/planning/archive/patrol-firebase-testing/review.md | Archives the detailed Patrol/Firebase Test Lab review. |
| docs/planning/archive/patrol-firebase-testing/readme-review.md | Archives a meta “documentation review” for the Patrol plan bundle. |
| docs/planning/archive/patrol-firebase-testing/plan.md | Archives the Patrol/Firebase Test Lab implementation plan. |
| docs/planning/archive/deep-linking/testing-strategy.md | Archives the deep-linking testing strategy document. |
| docs/planning/archive/deep-linking/phase-0-guide.md | Archives the deep-linking Phase 0 implementation guide. |
| docs/planning/archive/deep-linking/design.md | Archives the deep-linking design document. |
| docs/planning/archive/deep-linking/design-review.md | Archives the deep-linking design review. |
| docs/planning/archive/deep-linking/PHASE-1-HANDOFF.md | Archives Phase 1 handoff notes for deep linking. |
| docs/planning/archive/deep-linking/PHASE-1-COMPLETE.md | Archives a Phase 1 completion summary for deep linking. |
| docs/planning/archive/ci-review/ci-review.md | Archives CI/CD review notes. |
| docs/planning/archive/ci-review/ci-naming-recommendations.md | Archives CI naming recommendations. |
| docs/planning/archive/ci-review/ci-improvements-summary.md | Fixes archived CI review links for new doc locations. |
| docs/code/ui-components.md | Adds “current code” documentation for shared UI components. |
| docs/code/navigation.md | Adds “current code” documentation for navigation helper utilities. |
| docs/code/accessibility.md | Updates accessibility status to “implemented” and lists coverage + tests. |
| docs/adr/README.md | Updates ADR index to include ADR 0004 and 0005. |
| docs/adr/0004-path-based-url-strategy.md | New ADR documenting path-based, festival-scoped URL strategy. |
| docs/adr/0005-e2e-testing-strategy.md | New ADR documenting Playwright-only URL smoke testing scope. |
| docs/README.md | Restructures the docs landing page to match the new organization (code → ADRs → processes → tooling → planning → archive). |
| README.md | Updates top-level README E2E testing section (removes Patrol mention, links ADR 0005). |
| AGENTS.md | Updates API documentation links from docs/api/ to docs/code/api/. |
| .gitignore | Fixes the mock un-ignore pattern and adds screenshots/ to ignored paths. |
Contributor
🚀 Cloudflare Pages PreviewYour preview deployment is ready! Preview URL: https://claude-review-flutter-app-u7.staging-cambeerfestival.pages.dev This preview will be automatically updated when you push new commits to this PR. |
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
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.
Summary
This PR reorganizes the documentation structure to improve clarity and maintainability. Planning documents are archived with decisions extracted into Architecture Decision Records (ADRs), implementation status is updated to reflect completed work, and the docs README is streamlined.
Key Changes
Documentation Reorganization
docs/adr/directory with two new ADRs:docs/planning/archive/directory containing completed/superseded planning docs:archive/deep-linking/-- Phase 1 complete, decisions captured in ADR 0004archive/patrol-firebase-testing/-- not implemented, decision captured in ADR 0005archive/ci-review/-- implemented, decisions captured in ADRs 0001-0003Implementation Status Updates
docs/code/accessibility.md: Updated from "NOT IMPLEMENTED" to "✅ Implemented" with 53+ Semantics widgets and 9 dedicated testsdocs/code/navigation.mdanddocs/code/ui-components.md: Renamed (previously unnamed files)docs/code/domain-architecture.md: Added to code/ documentationdocs/code/widget-standards.md: Added to code/ documentationREADME Improvements
docs/README.md: Completely restructured for clarity:Content Updates
AGENTS.md: Updated API documentation paths fromdocs/api/todocs/code/api/README.md:docs/processes/ci-cd.md:docs/todos.md:docs/tooling/flutter-web-testing.md: Updated Semantics widget count from 24 to 53+, added reference to accessibility.mdNotable Details
docs/planning/→docs/planning/archive/)https://claude.ai/code/session_01L2cfZXThqbJdZmozMDr4DQ