Skip to content

docs(readme): merge repeated sections - #17

Merged
akilicarslan merged 1 commit into
mainfrom
docs/readme-dedupe
Nov 3, 2026
Merged

docs(readme): merge repeated sections#17
akilicarslan merged 1 commit into
mainfrom
docs/readme-dedupe

Conversation

@akilicarslan

@akilicarslan akilicarslan commented Nov 3, 2026

Copy link
Copy Markdown
Owner

What changed

The README said the same things in several places. This PR merges the repeats. The file is 57 lines shorter.

  • Architecture: the folder tree is now under the mermaid diagram. The Reference "Repository structure" section is removed. Its dependency line had the arrows in the opposite direction from the diagram.
  • Quick start: the requirements table is now here. The separate Requirements and Install sections are removed.
  • Run the tests: the "Other checks" command list is replaced by a link to Quality gates.
  • Detox: the Android subsection is removed. Known limits gives this fact.
  • Accessibility and AI: the two short sections are removed. Their content is in the Feature map rows. This also removes a sentence about "patient-facing healthcare apps".
  • Reference: the sections are renumbered (11 → 6). The Quick start link, the "step 2.1" reference and the Contents line are updated.

Why

Repeated text becomes different over time. Test counts and commands were in three places.

For the reviewer

  • Docs only. No other file links to README anchors.
  • pnpm verify and prettier --check README.md pass.
  • The Feature map row keeps "(Section 504)". It may come from the original brief.

🤖 Generated with Claude Code

@akilicarslan @claude
docs(readme): merge repeated sections
368aa17 
- Move the folder tree into Architecture. Remove the old
  Repository structure section and its reversed dependency arrows.
- Merge Requirements and Install into Quick start.
- Replace the "Other checks" list with a link to Quality gates.
- Remove the Android Detox subsection. Known limits gives this fact.
- Move the Accessibility and AI sections into Feature map rows.
- Renumber the Reference sections and update the links to them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@akilicarslan
akilicarslan merged commit a84d97c into main Nov 3, 2026
1 check passed
@akilicarslan
akilicarslan deleted the docs/readme-dedupe branch November 3, 2026 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@akilicarslan