Repository navigation
docs: rewrite the docs site for developers - #38
Merged
Merged
Conversation
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>
Deploying odal-node-docs with
|
| 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 |
Signed-off-by: chillin_since_26 <aleksandar.temelkov@live.com>
3 tasks done
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>
5 of 6 tasks
3 of 4 tasks
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.
Summary
Rewrites docs.odal-node.io for a developer evaluating or integrating Odal Node, following the org style guide (
DOCS-STYLE.mdin 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 accepttext/html, so every crate link read as broken. The checker now sends a browser-likeAcceptheader; 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, whichastro checkrefuses). Astro 7.4.2 needs Node >= 22.23.4, soenginessays so, and a new.node-versionpins 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 undersite/dpp-docs/src/content/docs/(introduction, quick start, core, engine, guides), the sidebar, andllms.txt.docs: say supersede sends the superseded event: the rewrite had the webhook events page saysupersedesends no event. It does:supersedeandamendboth publishdpp.passport.supersededwithsuccessorId.fix(scripts): check that link anchors resolve:check:linksskipped 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/apipage 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'smainbranch, which the quick start builds, and that eachCHANGELOG.mdsays what a tagged release contains.Based on
staging: merge here, review on thestagingpreviews, then promotestagingtomain.Checklist
pnpm -r buildandpnpm -r checkpnpm run check:links,check:leakage,check:llmsandcheck:sitemapspnpm run test:scripts(the link checker tests, rerun after the commit).envfiles in the diff