Repository navigation
📖✨:give the docs pages the site's design - #1846
Merged
Merged
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
12 times, most recently
from
August 24, 2026 01:44
4bef31e to
6550bfa
Compare
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
DerekNonGeneric
force-pushed
the
feat/docs-pages
branch
from
August 24, 2026 01:46
6550bfa to
46320ba
Compare
OpenINFbot
approved these changes
Aug 24, 2026
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 trail back up, which the pages had no link for. 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 license files beside it: CC BY-SA 4.0 under the handbook, CC BY-NC-SA 4.0 elsewhere. A page adapted from Google says so with one line of frontmatter, which reads the source page off its own filename. The trail is built from somewhere a reader can go rather than from the slashes in a URL. Nothing sits at `/docs/handbook/` or at `/news/2026/08/`, so splitting the URL would link into nothing on thirteen of fifteen pages; a step appears only where a page or a named section does. That is what `deep-page` is for, and it has it back. Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is> Assisted-by: Claude-Code:claude-opus-5 Assisted-by: Claude-Code:claude-fable-5 Fixes: #1545
DerekNonGeneric
force-pushed
the
feat/docs-pages
branch
from
August 24, 2026 02:03
46320ba to
56ca587
Compare
OpenINFbot
approved these changes
Aug 24, 2026
|
The commit queue did not land this. See https://github.com/OpenINF/openinf.github.io/actions/runs/32682535207 — the label has been taken back off, so re-applying it is a deliberate second try. |
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.
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.
Fixes: #1545
Breadcrumbs
That issue asks for a solid breadcrumb, and points at
ampproject/amp.dev#3036, where the trail in one section never terminated
while another section's did. The difference is where the trail comes from.
Splitting a URL on slashes would link into nothing on thirteen of fifteen
deep pages here. There is no page at
/docs/handbook/, at/docs/dev/faq/, orat
/news/2026/08/. So a step appears only where a page sits at that URL, orwhere
_data/sections.jsonnames somewhere else it can point, and the trailalways terminates at the front page. Zero dead links across the site.
It stops short of the page it is on, whose title is the heading directly below
it and was otherwise read twice. The
BreadcrumbListstructured data stillcarries the whole chain, because search results want it.
This is what
deep-page.liquidwas always for, and it has that back.Four things now render that never have
The Key Point. Every handbook page carries one. Only the index read it.
The credit 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.
Recommended against not recommended. The content has carried
.compare-betterand.compare-worseall along, unstyled, so both halves werethe same plain text and a reader could not tell which example was the good one.
Callouts.
> [!NOTE]was reaching the page as literal bracketed text.Licensing
Each page states the terms of the license file beside it: CC BY-SA 4.0 under
handbook/, CC BY-NC-SA 4.0 elsewhere, with the Creative Commons buttons forthose terms rather than one fixed pair. A page adapted from Google says so with
google: true, which reads the source page off its own filename; where the twodiffer,
google: inclusive-documentationnames Google's slug instead. Twopages are credited, eleven are not.
Worth a look before merging: the deleted layout claimed CC BY 4.0 for OpenINF's
own content, contradicting both the README and the two
LICENSEdirectories.Two sources agree with each other and disagree with it, so this follows them.
Also
Pages date themselves from when git last touched them, so
deploy.ymlneedsfetch-depth: 0; a shallow clone would date every page to the build, and thefilter reports nothing rather than guess. "Improve this page" opens against
liverather thanHEAD, which GitHub's editor cannot commit to.handbook-content-g-devdocs-style.liquidandkey-point.liquidare deleted.Checks
nps testpasses, all 17. Every internal link and asset reference in the builtsite resolves, as does every anchor. One
h1a page, no skipped heading levels,no dangling
aria-labelledby, and fifteen validBreadcrumbListblocks.Contrast is computed against composited color, not read off the palette. Text
runs 5.34:1 to 13.97:1; the three rules that are not text sit at 3.37, 3.39 and
4.33 against the 3:1 they answer to.
The four page shapes were rendered at 1440, 1024, 820 and 390 and had no
horizontal overflow. That was before the breadcrumb, the buttons and the edit
control were added, and those have not been through a browser: each wraps or
is small enough not to set a floor, and the wide table is its own scroll
container, but the reasoning is structural rather than seen.
Two bugs came out of rendering rather than reading. Bootstrap's
--bs-code-colorwas turning every inline code span pink, and two autolinkedbare URLs overflowed at 390px.