📖✨：give the docs pages the site's design - #1846
Open
DerekNonGeneric wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for gh-pages-openinf ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
DerekNonGeneric
force-pushed
the
feat/docs-pages
branch
from
August 23, 2026 01:42
6e2f61b to
f43bea7
Compare
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
DerekNonGeneric
force-pushed
the
feat/docs-pages
branch
8 times, most recently
from
August 23, 2026 05:11
2bdc6f0 to
471f2a2
Compare
The index was rebuilt and the fourteen pages under it were not, so every link out of it landed on a 48ch column wrapped in `.grid`, `.unit`, `.four-fifths` and `.improve`, none of which are styled anywhere. Four things now render that never have. The Key Point each handbook page carries, which only the index was reading. The attribution the colons page owes Google, whose only renderer was a layout no page loads. A way back to the index, which the pages had no link to. And the recommended and not-recommended examples as a distinguishable pair, having until now been the same plain text twice. The terms each page states come from the licence files beside it: CC BY-SA 4.0 under the handbook, CC BY-NC-SA 4.0 elsewhere. Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is> Assisted-by: Claude-Code:claude-opus-5 Assisted-by: Claude-Code:claude-fable-5
DerekNonGeneric
force-pushed
the
feat/docs-pages
branch
from
August 23, 2026 05:22
471f2a2 to
1dc14e8
Compare
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 index was rebuilt and the fourteen pages under it were not. Every link out
of it landed in a 48ch column wrapped in
.grid,.unit,.four-fifthsand.improve, none of which are styled anywhere in the repository.Following Google's developer documentation style guide in structure, since the
handbook content is already written in its markup, but in this site's own
palette and type rather than devsite's.
Four things now render that never have
The Key Point. Every handbook page carries one in frontmatter. Only the
index was reading it.
The attribution the colons page owes Google. It reproduces CC BY 4.0
content, and the only layout that ever rendered the credit is one no page
loads. That page has been published without it.
A way back. Handbook pages return to
/docs/#handbook, the rest to/docs/. Previously the navbar was the only route.Recommended and not recommended as a distinguishable pair. The content has
carried
.compare-betterand.compare-worseall along, unstyled, so bothhalves rendered as the same plain text and a reader could not tell which
example was the good one. Teal rule and label for one, quaternary for the
other, chosen with
:has()so the rule and the label cannot disagree.Licensing
Each page states the terms of the licence file sitting beside it: CC BY-SA 4.0
under
handbook/, CC BY-NC-SA 4.0 elsewhere. The README agrees.Worth a look before merging: the dead layout's footer claims CC BY 4.0 for
OpenINF's own content, which contradicts both the README and the two
LICENSEdirectories. Two sources agree with each other and disagree with it, so this
follows them. If it had it right, say so and it flips.
Checks
nps testpasses, all 17. Contrast computed against composited colour: textpairs run 5.34:1 to 13.97:1, and the two example rules sit at 3.37:1 and
4.33:1 against the 3:1 bar that applies to non-text. All four page shapes
verified — a page with a Key Point and attribution, a stub with a callout, a
long page with tables and code, and
/about/vision/, which correctly has nofooter, no Key Point and no breadcrumb.
Two real bugs found by rendering
Bootstrap's
--bs-code-coloris#d63384, and reboot targets barecode, soevery inline code span on these pages was hot pink. Two autolinked bare URLs in
the contributing guide overflowed the viewport at 390px, having no space to
break at.
Neither was visible from reading the stylesheet.