Skip to content

Thin the README and move the guide into the docs site - #31

Merged
mysticmind merged 2 commits into
mainfrom
thin-readme
Oct 9, 2026
Merged

mysticmind merged 2 commits into
mainfrom
thin-readme

Conversation

@mysticmind

Copy link
Copy Markdown
Owner

The README was the source of the docs site. Now that the site is live, the guide lives there and the README is a short entry point.

  • README: down from about 860 lines to about 100. It keeps the introduction, installation and the platform table, adds a quick start (compiled and run to check its output) and a table of links into the docs, and keeps the license section.
  • Docs: the nine guide pages under docs/guide are now ordinary Markdown files, with the content they had when generated from the README. The generator script is reduced to copying the artwork from assets. Each page gets an "Edit this page on GitHub" link.
  • Workflows: the docs workflow no longer triggers on README changes, and CI skips changes under docs/.
  • Package: the release notes link points at the What's new page of the docs.

@mysticmind
mysticmind merged commit d0693b5 into main Oct 9, 2026
25 checks passed
@mysticmind
mysticmind deleted the thin-readme branch October 9, 2026 16:52
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