Skip to content

Rewrite the open-source documentation site - #2698

Merged
MarcusSorealheis merged 1 commit into
TraceMachina:mainfrom
amankrx:docs/oss-rewrite
Aug 20, 2026
Merged

Rewrite the open-source documentation site#2698
MarcusSorealheis merged 1 commit into
TraceMachina:mainfrom
amankrx:docs/oss-rewrite

Conversation

@amankrx

@amankrx amankrx commented Aug 19, 2026

Copy link
Copy Markdown
Member

What and why

Rewrites the open-source documentation site from the ground up until v1.6.5. The old docs were a catalogue of pages grouped by artifact type; this replaces them with a reading path (Getting started, Remote execution, Configuration, How-to guides, then Operate), one page per concept, every behavioral claim checked against the source and linked to it at the pinned release tag, and the configuration, metrics and changelog references generated from the repository rather than transcribed. Kubernetes deployment now points at NativeLink Enterprise, the retired Cloud tier is gone, and the site carries /llms.txt and /llms-full.txt so agents can read the whole corpus in one fetch.

The rendered site is the best way to review the content: https://nativelink-git-fork-amankrx-docs-7b750d-native-link-web-assets.vercel.app/. Beyond the pages, these parts need eyes in the diff:

  • .github/workflows/docs-lint.yaml (new): five lints on every docs PR, plus a "generated pages are not hand-edited" check and a weekly external-link sweep.
  • web/apps/docs/scripts/: New scripts added and updates to the existing scripts.
  • web/apps/docs/components/: Prerequisites, NextStep, VerifyBlock, SourceLink, MinVersion (new), registered in mdx-components.tsx.
  • web/apps/docs/lib/source-ref.ts (new): the single pinned ref (v1.6.5) every <SourceLink> resolves against; lib/config-versions.ts regenerated (18 versions, v1.6.5 latest).
  • web/apps/docs/next.config.mjs: the redirect table for every moved or removed URL (/deployment/, /rbe/, /configuration/, /getting-started/).
  • web/apps/docs/templates/ (new): the four page archetypes and a README on how they're used.
  • Deleted pages (19): deployment/, rbe/, configuration/{basic,chunking,compression,intro,production}, getting-started/{on-prem,other-build-systems/index}; each has a redirect. Deleted kubernetes/README.md (pointed at Artifact Hub; Kubernetes now points at Enterprise). Basically, the old docs
  • .github/styles/config/vocabularies/TraceMachina/accept.txt: ~135 technical terms added so Vale passes; worth a skim for anything that should have been a fix instead.
  • Small: README.md and deployment-examples/persistent-workers/kotlin/README.md link updates, .gitignore (.turbo/), web/apps/docs/.gitignore (generated changelog and llms files), package.json scripts, source.config.ts (Shiki starlark alias), app/layout.tsx title template.

How was this verified?

Every page was verified against the v1.6.5 checkout (Rust source, config crate, examples, protos, workflows, LICENSE and file headers), and against the third-party tools' own docs for Bazel, Buck2, Siso, Pants, BuildStream and recc flags; wrong claims were corrected or removed.

Risk

Docs only; no binary or config change. Old URLs redirect (next.config.mjs), so cached links keep working.


This change is Reviewable

@vercel

vercel Bot commented Aug 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
nativelink Ready Ready Preview Aug 20, 2026 4:41pm
nativelink-aidm Ready Ready Preview Aug 20, 2026 4:41pm

Request Review

@github-actions

This comment has been minimized.

@MarcusSorealheis

Copy link
Copy Markdown
Member

Excellent PR!

@MarcusSorealheis MarcusSorealheis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@MarcusSorealheis
MarcusSorealheis merged commit 8ae3317 into TraceMachina:main Aug 20, 2026
48 of 50 checks passed
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