Repository navigation
fix(docs): working links, better search and AI answers, keyboard and contrast fixes - #243
Merged
Merged
Conversation
…k every link after the build Pages kept Docusaurus-style relative links (../versioning, ./panel/install). With trailingSlash the browser resolved them one folder too deep, so about 50 links on 13 pages went to 404s. lib/docs-href.ts resolves them at build time for the HTML pages and the .md copies alike, and scripts/check-links.mjs (postbuild, check:links) fails the build on any docs link to a page, file or #anchor that isn't there.
The last-modified plugin reads git. With a depth-1 checkout every page got the date of the latest commit in the sitemap, article:modified_time, JSON-LD and "Last updated".
…itles Pages that started with a heading or a warning box now say what they are for in one or two sentences (facts already in the docs). Headings under the title start at H2 (index, contributors, standalone install pages, SSL tabs). Vague titles say what and for which part: "Using Redis with the Panel", "Advanced Wings Configuration", … (URLs unchanged). Short descriptions for Podman, the webserver config and Cloudflare Tunnel are longer.
…s/llms.txt too Adds the Plugin Hub, points Support at /sponsor, drops the trailing slash from the Hub's /eggs and /faq, and links the Hub API docs that exist (hub.pelican.dev/docs/api). The phone menu's links to the Hub's pages are plain <a>s, so they keep /sponsor instead of /sponsor/.
…atePublished; link the Markdown copy TechArticle's author and publisher are the Organization the Hub's home page defines (@id https://pelican.dev/#organization). datePublished is the page's first commit (skipped on a shallow clone). Each page has <link rel="alternate" type="text/markdown"> to its .md.
…irect target exists /docs/panel/config, /docs/eggs/creating-a-custom-docker-image, /docs/panel/updating-panel, /docs/wings/installing-wings, /docs/wings/updating-wings, /docs/team and /updatePanel.sh. check-links now also fails when a /docs redirect points at a page that isn't built.
…om the keyboard Phone sidebar: Escape closes it, the page behind it is inert, focus moves in when it opens and back to the menu button when it closes. Search: focus returns to the button that opened it, and a live region says how many results there are.
…edges and focus - "Skip to content" is the first thing Tab reaches. - The brand link's name includes its visible text; code scroll areas are named; "Open" reads "Open in…". - Code comments use #8b949e (4.6:1 or more, also on highlighted lines). - Dark-theme control edges are 3:1 or more; the search input shows a focus ring. - The logo icon is a 5 KB WebP instead of the 36 KB PNG.
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the
|
Four descriptions ran to 166-180 characters and the Comparison title to 66 with ' | Pelican Docs'; Google cuts them at about 160 and 60.
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.
Why
An audit found about 50 docs links that lead to "page not found", the same "Last updated" date on every page, pages that search engines and AI tools can't quote well, and keyboard and screen reader problems. This fixes them, and a new build check stops broken links from coming back.
Search and AI answers
check:linksfails the build on a broken link, #anchor or redirect./sponsor, Hub API);/docs/llms.txtworks.netlify.toml, "Older names"). The Hub picks them up from the docs build (redirects.json).Accessibility
Checked
bun test: 161 passbun run typecheck: okbun run build: ok;check-linksok on 35 pages (54 broken before)Not checked