Simplify the documentation site - #1140
Merged
Merged
Conversation
compute_source_size called every registered entry for a problem name and relied on catch_unwind to swallow the unwrap panics from entries whose source variant did not match the instance. The default panic hook still printed those panics to stderr, so `pred solve` on a default-variant instance emitted spurious 'thread main panicked' lines before succeeding. Filter entries by source variant as well as name and drop the catch_unwind. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Heb7aLYWxgQE4v6TPNAQE4
Collapse the 38-page guide into 8 pages plus a placeholder: overview, CLI quick start and command reference, reduction graph, skills, Rust getting started, API, design, and open problems. Remove repeated --help, rustdoc, and CLAUDE.md content and the per-page link chains. Drop MCP from the documentation. Re-record the CLI demo with scripts/record_cli_demo.py: blank lines between command blocks and a direct ILP solve instead of brute force. Strip decorative copy from the landing page and remove the legacy anchor redirects. Update the documentation and website test suites. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Heb7aLYWxgQE4v6TPNAQE4
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1140 +/- ##
==========================================
- Coverage 98.00% 98.00% -0.01%
==========================================
Files 1044 1044
Lines 107366 107380 +14
==========================================
+ Hits 105228 105234 +6
- Misses 2138 2146 +8 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Homepage: drop the decorative labels around the hero graph, the overlay card, the "Atlas" stats label, the category tagline, and the example pill. Set the "Problem Reductions" title and section headings in one typeface. Rename the "Infrastructure" nav item to match its "Get started" section. Remove the now-unused CSS. Docs: replace the Markdown/All pages header links with GitHub and Atlas links. Replace the interactive module map on the Design page with a "Depends on" column in the module table and delete the module-graph generator, assets, and unused module-overview diagram. CLI recording: the player page embedded a stale copy of the cast without blank lines between commands. The recording script now collapses trailing blank lines and embeds the cast into cli-demo.html itself. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WQFSR77SahSqX36EpNCPUT
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.
Summary
--help, rustdoc, and CLAUDE.md content and the per-page "Before you start / Next" chains are gone. The Skills page lists every skill under.claude/skills/in one table.--features mcpcode is untouched.scripts/record_cli_demo.pythat runs the real CLI in a PTY. Command blocks are now separated by a blank line and the final command is a plainpred solve cycle.jsonusing the default ILP solver; brute force no longer appears.catalog-counts.mdsnippet generated bypred list --json, and carries the paper's BibTeX entry.docs-theme.js; the old page names (cli.html,skills.html,design.html) are back, so README links resolve directly.Bug fix
Re-recording exposed a real bug:
pred solveon a default-variant instance printed fourthread 'main' panickedmessages before succeeding.ReductionGraph::compute_source_sizecalled every entry registered under the problem name and relied oncatch_unwindto swallow theunwrappanics from entries whose source variant did not match; the default panic hook still printed them. It now filters by variant as well and no longer catches panics. Covered bytest_compute_source_size_only_consults_matching_variant.Verification
make website, thentypst compileandcargo docintobook/scripts/test_documentation.py(artifacts + browser) andscripts/test_website.py: all passcargo test --lib: 5277 passed;cargo clippy --all-targets --features ilp-highs: clean🤖 Generated with Claude Code
https://claude.ai/code/session_01Heb7aLYWxgQE4v6TPNAQE4