Compact the README; add an Overview chapter to the docs#34
Merged
Conversation
The README had grown a long per-class middle that a first-time visitor is unlikely to read in full. Compress it to what earns a landing page and move the depth into the docs: - README now keeps the motivational overview, minimal usage examples, the structure-vs-class distinction and its algorithmic use, a table of the implemented structures and classes, the changelog animation, and references; it links to the documentation up front. - New docs/source/overview.md is the guided tour that used to live in the README middle — decision procedure, computer algebra, uniform classes, composition, bounded rank-width, implicit evaluation, and how it works (including the integer encoding and the automaton diagram) — wired in as the first entry of the docs, with theme-aware images and cross-links to the notebooks. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Drop the URL-in-label, the explicit overview-chapter call-outs, and the short- version framing in favor of a plain pointer to the documentation. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
The README had grown a long per-class middle that a first-time visitor is unlikely to read in full. This compresses it to what earns a landing page and moves the depth into the documentation.
README now keeps the motivational overview, minimal usage examples, the structure-vs-class distinction and its algorithmic use, a compact table of the implemented structures and classes, the changelog animation, and the references — and links to the documentation up front.
New
docs/source/overview.mdis the guided tour that used to live in the README middle: decision procedure, computer algebra over ℤ[1/p], uniform classes, composition, bounded rank-width, implicit evaluation, and how it works (the integer encoding and the automaton diagram). Wired in as the first entry of the docs, with theme-aware images (only-light/only-dark) and{doc}cross-links to the notebooks.Verified with a full local
sphinx-build -W(no warnings; overview + all notebooks build, images and cross-refs resolve); the README code examples were run to confirm their outputs.🤖 Generated with Claude Code