Skip to content

docs: add redirects for moved pages and fix broken links - #9979

Merged
nishantmonu51 merged 6 commits into
mainfrom
nishant/docs-link-integrity
Oct 5, 2026
Merged

nishantmonu51 merged 6 commits into
mainfrom
nishant/docs-link-integrity

Conversation

@nishantmonu51

Copy link
Copy Markdown
Collaborator
  • Redirect 30 URLs of pages moved or deleted in 2026 (developers/guides, embed-api, data-source/{openai,claude,slack}, time-syntax, v50 notes), plus data-source/{clickhouse,druid,pinot,starrocks,motherduck}.
  • Fix broken anchors and links on the security, view-as-user, home page, and PostgreSQL/DuckLake connector pages; point canvas defaults.time_range at the time syntax reference.
  • Make schema, blog, FAQ and models-101 self-links site-relative so the Docusaurus build checks them.
  • Generated model file headers now use the driver's docs URL reported by the runtime (falling back to the models reference) instead of the nonexistent data-source/<driver> pages.

Checklist:

  • Covered by tests
  • Ran it and it works as intended
  • Reviewed the diff before requesting a review
  • Checked for unhandled edge cases
  • Linked the issues it closes
  • Checked if the docs need to be updated. If so, create a separate Linear DOCS issue
  • Intend to cherry-pick into the release branch
  • I'm proud of this work!

- Redirect 30 URLs of pages moved or deleted in 2026 (developers/guides,
  embed-api, data-source/{openai,claude,slack}, time-syntax, v50 notes),
  plus data-source/{clickhouse,druid,pinot,starrocks,motherduck}, which
  generated model files link to.
- Fix the iframe anchor on the security and view-as-user pages, the
  home page embed links, and the PostgreSQL and DuckLake connector cards'
  YAML Reference anchors.
- Point the canvas defaults.time_range description at the time syntax
  reference, and make schema, blog, FAQ and models-101 self-links
  site-relative so the build checks them.
Docusaurus treats https://docs.rilldata.com links as external and does
not see hrefs that React components build at render time, and it only
warns on broken anchors. scripts/check-docs-links.js indexes docs/dist
(pages, element ids, client redirects and _redirects), then resolves
every docs.rilldata.com URL in docs, blog, runtime, cli, admin and the
web apps, plus every internal href in the built HTML, and fails on a
missing page or anchor. Absolute self-links in docs prose only warn.

Links already broken on main with a fix pending elsewhere are listed in
KNOWN_BROKEN; remove each entry with its fix. The check uses only Node
built-ins and runs in the docs workflow's build job on pull requests.
Create model on a ClickHouse, Druid, Pinot, StarRocks or MotherDuck table linked to data-source/<driver>, which does not exist. Use the docs URL the runtime reports for the driver, and fall back to the models reference.
Use "time range syntax" instead of "rilltime" for the data_time_range link text, and remove a stray "4›4" line from the 0.9 release notes.
The link check skipped every directory named "build", which hid docs/docs/developers/build. Stop skipping it, allow the dead explores link there until the explore page rewrite fixes it, and note that code blocks are checked and that product-only changes are checked on the next docs pull request.
@nishantmonu51
nishantmonu51 requested a review from pjain1 October 1, 2026 15:56
@nishantmonu51
nishantmonu51 merged commit 619fa39 into main Oct 5, 2026
18 checks passed
@nishantmonu51
nishantmonu51 deleted the nishant/docs-link-integrity branch October 5, 2026 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants