docs(readme): declutter and reorder for usage-first reading - #23
Merged
Conversation
Restructure to remove repeated material and tighten the flow. No claims changed; Quickstart, roadmap, and all links are preserved verbatim. - Keep the intro + "Why ARK" (merged Vision + Problem Statement) up top, then lead with Core Modules + Quickstart + Input/Output Model so the packages and a runnable example come early. Where ARK fits / Design principles follow. - Merge Goals + Product Philosophy into a single 5-bullet "Design principles" (Non-goals kept as-is). - State the human-summary + JSON duality once (Output Model) instead of in four places; describe the packages once (Core Modules) instead of three. - Trim the Repository layout tree and give the fence a text language tag. - Drop the redundant Status section (the roadmap already shows state) and the marketing closing line. - Link the previously-orphaned docs/ARCHITECTURE.md from Development. 227 -> 177 lines. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
mikim
force-pushed
the
docs/readme-declutter
branch
from
July 25, 2026 00:55
4378ffd to
cca6bda
Compare
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.
Restructures the README so the practical content leads and the conceptual prose follows, and removes repeated material. No claims changed — Quickstart code, roadmap, and every link are preserved verbatim (verified). 227 → 177 lines.
What changed
Reorder (usage-first):
Core Modules → Quickstart → Input/Output Modelnow sit directly under the intro, so a reader reaches the packages and a runnable example immediately.Why ARK,Where ARK fits, andDesign principlesfollow.De-duplicate:
Merge overlapping sections:
Vision+Problem Statement→ one Why ARK.Goals+Product Philosophy(two numbered lists covering much of the same ground) → one 5-bullet Design principles. Non-goals kept as-is.Cleanup:
textlanguage tag (consistency with the other fences).Before → after section order
Vision, Problem, Goals, Philosophy, Core Modules, Where-fits, Quickstart, Input, Output, Users, Roadmap, Metrics, Layout, Dev, Status, (closing)→
Core Modules, Quickstart, Input, Output, Why ARK, Where-fits, Design principles (+Non-goals), Users, Roadmap, Metrics, Layout, DevDocs-only; no code or schema change.