Skip to content

docs: rewrite the docs site for developers - #38

Merged
LKSNDRTMLKV merged 8 commits into
stagingfrom
docs/dx-rewrite
Oct 27, 2026
Merged

LKSNDRTMLKV merged 8 commits into
stagingfrom
docs/dx-rewrite

Conversation

@LKSNDRTMLKV

@LKSNDRTMLKV LKSNDRTMLKV commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Summary

Rewrites docs.odal-node.io for a developer evaluating or integrating Odal Node, following the org style guide (DOCS-STYLE.md in odal-node/.github): quick start first, mechanisms instead of claims, no em dashes in prose, and sealing presented as experimental. Two supporting commits come first: the external link checker asks for HTML, and the Astro toolchain is upgraded with Node pinned to the version CI already uses.

Changes

  • fix(scripts): ask for HTML when checking external links: crates.io answers 404 to a request that does not accept text/html, so every crate link read as broken. The checker now sends a browser-like Accept header; a new test covers a server that only answers HTML requests.
  • chore(deps): upgrade Astro to 7.4 and pin Node 24.18.0 for builds: Astro 7.4.2, Starlight 0.42.7, Scalar 1.76.0, sitemap, Vue, sharp, and TypeScript 6.0.3 (held below 7.0, which astro check refuses). Astro 7.4.2 needs Node >= 22.23.4, so engines says so, and a new .node-version pins 24.18.0 so Cloudflare Pages builds with the same Node as CI. This overlaps the open Dependabot PRs for Starlight and Scalar.
  • docs: rewrite the docs site for developers: 18 pages under site/dpp-docs/src/content/docs/ (introduction, quick start, core, engine, guides), the sidebar, and llms.txt.
  • docs: say supersede sends the superseded event: the rewrite had the webhook events page say supersede sends no event. It does: supersede and amend both publish dpp.passport.superseded with successorId.
  • fix(scripts): check that link anchors resolve: check:links skipped every #fragment, so a reworded heading left its anchor links pointing at nothing while the gate stayed green. A fragment must now name an id on the page it lands on, same-page, cross-page and cross-site. The script-rendered /api page is skipped. Proven to fail on all three kinds of break; 969 anchors resolve today.
  • docs(web): state the Node version builds need: the README still said Node 22.13+, below the 22.23.4 this PR's own upgrade requires.
  • docs: name GS1 Digital Link as one digital link: across both sites, the link in the product's code is a digital link, and GS1 Digital Link is one kind of it. A passport without a GTIN (an identification link or a DID) gets /dpp/{id} on the resolver. "GS1 Digital Link" stays where the text is about the GS1 routes themselves. The landing glossary gains "Digital link". The architecture page no longer says the resolver "enforces access rights": it serves only the public view, and restricted parts are read from the node with a credential.
  • docs: say the pages describe main: the introduction's status note now says the pages describe each repository's main branch, which the quick start builds, and that each CHANGELOG.md says what a tagged release contains.

Based on staging: merge here, review on the staging previews, then promote staging to main.

Checklist

  • pnpm -r build and pnpm -r check
  • pnpm run check:links, check:leakage, check:llms and check:sitemaps
  • pnpm run test:scripts (the link checker tests, rerun after the commit)
  • No secrets, credentials, or .env files in the diff
  • Founder review of every page before merge

Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
@LKSNDRTMLKV LKSNDRTMLKV added the documentation Improvements or additions to documentation label Oct 27, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Deploying odal-node-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7ecd26c
Status: ✅  Deploy successful!
Preview URL: https://36e81f74.odal-node-docs.pages.dev
Branch Preview URL: https://docs-dx-rewrite.odal-node-docs.pages.dev

View logs

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Deploying odal-node-landing with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7ecd26c
Status:⚡️  Build in progress...

View logs

Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
@LKSNDRTMLKV
LKSNDRTMLKV changed the base branch from main to staging October 27, 2026 17:45
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
@LKSNDRTMLKV
LKSNDRTMLKV merged commit 90f6141 into staging Oct 27, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant