GitHub pages website - #10
Merged
Merged
Conversation
The front page was reading like a product page for the crate rather than
like the crate. It opened on a slogan I made up ("physics and mathematics
that check their own answers"), and the section under it was six invented
cards with parallel punchy headings, which is the shape a landing page
takes when nobody has anything specific to say. The repository already
has 46,000 characters written in a voice, so the page should be using it.
What changed:
* The headline is now the crate's actual one-line description, and the
standfirst is the README's opening paragraph verbatim.
* The six invented cards are gone. In their place: "At a glance", which
is the README's own table, and "Design", which is its five design
bullets verbatim.
* "Install and run something" is "Install"; "Where to go next" and
"Three doors, depending on what you came for" are "Further reading",
with the README's own descriptions of the guide, the map and the docs.
* The four testing mechanisms now carry the README's wording rather than
my compression of it.
One of the invented cards was also wrong. It said adding a velocity to a
time was "a compile-time-shaped error" -- `Quantity::add` checks the
dimensions at run time and returns `Err`, which is what the quick-start
snippet three sections down asserts. The claim is gone with the card.
The hero's gradient headline is gone too. Nothing on the page is
highlighted for emphasis it does not have.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01M6M2MuUNrr1XHjshdrXfwH
Rewritten with colons, commas, parentheses and full stops instead. The
changes are to punctuation only, no claim on the page changed:
checked - against a closed form -> checked: against a closed form
296 source files - see the map -> 296 source files (see the map)
none - Cargo.lock holds one package -> none. Cargo.lock holds one package
the point - exact works over -> the point: exact works over
ambiguous - the Frobenius number - the -> ambiguous (the Frobenius number), the
The strong Lucas test - the second -> The strong Lucas test, the second
half of Baillie-PSW - was replaced half of Baillie-PSW, was replaced
The Miri card was reordered rather than repunctuated, since it had two
parenthetical dashes stacked in one sentence.
Also the page titles, which used " - " as a separator, now use a middot,
and the empty-filter message and two file-header comments.
En dashes stay where they join two names, Baillie-PSW and Stern-Brocot.
Those are the README's own and are not em dashes.
The one in tools/build_site.py was the fallback for a module with no //!
summary, matching the fallback in gen_module_map.py. It is now a plain
hyphen. It never renders, since check_module_docs.py fails CI if any
source file is missing its summary.
The guide and module-map pages still carry 20, because they render
docs/GUIDE.md and docs/MODULE_MAP.md as written. Those are source files,
not site copy, so this leaves them alone.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01M6M2MuUNrr1XHjshdrXfwH
There was a problem hiding this comment.
🟡 Changes recommended
The homepage now hard-codes several generated totals and includes scope beyond the stated PR description, creating drift/mismatch risk and unclear review intent.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the GitHub Pages site’s presentation and copy, including front-page layout tweaks and minor wording/typography changes across generated docs and static assets.
Changes:
- Adjusts site text/SEO titles and several on-page metrics/copy blocks (notably
site/index.html). - Adds CSS rules for inline code and new front-page section/table styling.
- Tweaks the site generator output formatting (module summary fallback and document title separator).
File summaries
| File | Description |
|---|---|
| tools/build_site.py | Tweaks module summary fallback and document title separator used in generated pages. |
| site/styles.css | Adds styling for inline code and new front-page-specific layout components. |
| site/main.js | Minor wording change in the “no results” empty-state message. |
| site/index.html | Significant content/layout refresh for the homepage, including new “At a glance” section and copy edits. |
| site/404.html | Updates the title separator to match the new title style. |
| README.md | Updates website sentence punctuation/wording and a build-docs sentence separator. |
Review details
Suppressed comments (1)
site/index.html:349
- The Python section currently hard-codes the crate-wide totals (e.g., “4,149 free functions”, “2,277 methods”), which can become inconsistent with the generated totals used elsewhere on the page. Using
data-totalfor the denominators would keep these figures aligned withwindow.CRATE_TOTALS.
Published to PyPI as <strong>numeria</strong>: 4,086 of this crate's 4,149 free
functions, 2,254 of its 2,277 methods, 416 of its 426 types and every constant.
The bindings are generated from this crate's source, so they cannot fall behind
it.
- Files reviewed: 6/6 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+96
to
+103
| <tr><th>Public functions and methods</th> | ||
| <td>6,365 (4,124 free functions, 2,241 methods)</td></tr> | ||
| <tr><th>Public types</th> | ||
| <td>431 structs, enums and traits</td></tr> | ||
| <tr><th>Top-level modules</th> | ||
| <td>71 public, across 296 source files (see the | ||
| <a href="module-map.html">module map</a>)</td></tr> | ||
| <tr><th>Source</th><td>266,122 lines of Rust</td></tr> |
Comment on lines
+6
to
+10
| <title>rust_physics_engine</title> | ||
| <meta name="description" content="A zero-dependency Rust library for physics, mathematics and engineering computation. 6,365 public functions and methods across 71 modules."> | ||
| <link rel="canonical" href="https://rust-physics-engine.mimsec.com/"> | ||
| <meta property="og:title" content="rust_physics_engine"> | ||
| <meta property="og:description" content="A zero-dependency Rust library for physics, mathematics and engineering computation — 6,365 public functions across 71 modules, each written so that something about it can be checked."> | ||
| <meta property="og:description" content="A zero-dependency Rust library for physics, mathematics and engineering computation. 6,365 public functions and methods across 71 modules."> |
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
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.
update the website font