Skip to content

docs(readme): distill into a succinct overview - #122

Merged
drawmeanelephant merged 1 commit into
mainfrom
t3code/polish-readme
Aug 25, 2026
Merged

drawmeanelephant merged 1 commit into
mainfrom
t3code/polish-readme

Conversation

@drawmeanelephant

Copy link
Copy Markdown
Owner

Summary

  • Restructure the README from 375 to 110 lines: replace the Status feature dump and the per-section CommonMark scorecard with concise frontend summaries (Markdown / Textile / Cooklang), an opt-in extensions list, and pointers into docs/.
  • Keep the substance that belongs up front: identity and pipeline, clean-room statement, conformance headline (652/652), build/test commands, a minimal library snippet, C ABI pointer, CLI examples, prebuilt-binary URL pattern.
  • Add a short note on the project's namesake: Oliver, the Weimaraner of Dean Allen, Textile's creator (Daily Oliver).

Details removed (all still in the repo)

  • Per-feature parsing inventory → docs/CAPABILITIES.md, docs/FEATURE-MATRIX.md
  • Per-section scorecard table → reproduced by zig build spec-conformance -- spec.txt
  • Extension contracts → docs/MARKDOWN-EXTENSIONS.md and per-extension docs
  • Cooklang library snippets → docs/COOKLANG.md; C ABI sample → docs/C-ABI.md

All doc links verified to resolve.

Replace the feature-dump Status section and per-section scorecard
with frontend summaries, an opt-in extensions list, and pointers
into docs/. Note the project's namesake: Oliver, Dean Allen's
Weimaraner.
@drawmeanelephant
drawmeanelephant merged commit cf83637 into main Aug 25, 2026
3 checks passed
@drawmeanelephant
drawmeanelephant deleted the t3code/polish-readme branch August 25, 2026 21:39
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