Skip to content

docs: overhaul README, add docs index, and clean up stale docs - #70

Merged
siktec-lab merged 1 commit into
mainfrom
docs/readme-and-docs-cleanup
Nov 11, 2026
Merged

siktec-lab merged 1 commit into
mainfrom
docs/readme-and-docs-cleanup

Conversation

@siktec-lab

Copy link
Copy Markdown
Collaborator

Refresh user-facing documentation and benchmark summary automation:

  • Streamline main README with top badges, copy-paste quickstart/usage, accurate CLI reference, compact benchmark summary, and concise docs overview
  • Update sync_doc_benchmarks.mjs to emit a compact README benchmark table while keeping detailed summaries in tests/docs
  • Add top-level docs/README.md index and remove redundant/outdated specs in docs/system/ (07, 08, 09)
  • Fix broken relative links, stale runtime/benchmark figures, and missing Wave 1-3 API coverage across docs/ and tests/

@siktec-lab
siktec-lab merged commit 336fa1f into main Nov 11, 2026
3 checks passed
@siktec-lab
siktec-lab deleted the docs/readme-and-docs-cleanup branch November 11, 2026 19:38
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.

2 participants