Skip to content

docs(readme): redesign onboarding and expert navigation - #82

Merged
Rynaro merged 1 commit into
mainfrom
docs/readme-modernization
Oct 19, 2026
Merged

Rynaro merged 1 commit into
mainfrom
docs/readme-modernization

Conversation

@Rynaro

@Rynaro Rynaro commented Oct 19, 2026

Copy link
Copy Markdown
Owner

Rebuilds the README as a learner-to-expert entry point: original crystal SVG identity, concise navigation, a three-step MCP connection guide, plain-English memory layers, architecture, complete tool reference, trust tiers, and audience-specific paths into deeper docs.

Corrects stale onboarding and technical claims: explicit stdio startup instead of the dev image's pytest command, host-only Make wrappers, current storage volume and project selection, real schema-test target, local ECL sidecars, and current feature guidance. Historical ablation material is linked from maintained references rather than presented as current defaults. Latest release badge updates dynamically.

Validation: 184 conformance tests (G1–G8) and 10 focused docs/server-entrypoint tests passed. All 38 local links/anchors resolve; SVG is well-formed and accessible; whitespace checks pass. Independent ATLAS factual audit and VIGIL review completed. No runtime or test code changed.

@Rynaro
Rynaro merged commit 2fbb78f into main Oct 19, 2026
13 checks passed
@Rynaro
Rynaro deleted the docs/readme-modernization branch October 20, 2026 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant