Conversation
…aces Transplant the reader-facing content of the rc/202608 documentation refresh (PR #1049) onto main so the docs ship ahead of the release merge: - Rebuilt guides (adapters, configuration, testing, creative processing, integrations inventory, telemetry, tsjs, CLI, API reference), the restored public onboarding page, ten crate READMEs, and the internal decision and evidence records - The four adapter smoke scripts plus scripts/README.md, and the documentation-snippet compile test - docs/public/CNAME placeholder removed; VitePress config updated Re-pointed at main where the release branch differs: the rc-only `ts audit ad-templates` and `ts config ad-templates` command families are removed from the CLI guide (every remaining documented command probed against a main-built binary); CI-gate links target AGENTS.md; the documentation-checks aggregate script is left out because main's rustdoc does not yet pass with warnings denied, and testing.md lists the two commands that do run here; scripts/README.md lists only scripts present on main. Merge conflicts with main's newer CHANGELOG, README, TESTING, and auction README resolved to main's side. Verified: VitePress lint/format/build (dead links fail the build), documentation_snippets compiles against main's core, smoke-axum.sh boots main's adapter, and a claims scan checked every referenced script, repo path, and route against this tree.
Collaborator
Author
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
1 participant
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
Brings the documentation content of #1049 (approved against
rc/202608) tomainnow, instead of waiting ~2 weeks for the release merge. Scope is documentation surfaces only: the docs site, top-level and crate READMEs, the four adapter smoke scripts the guides teach, and the documentation-snippet compile test. None of #1049's Rust doc-comments, route-contract tests, startup diagnostics, or CI workflow changes are included — those land with the rc merge.What differs from the rc version
Everything was re-verified against
main, and the guides were re-pointed where the branches diverge:ts audit ad-templatesandts config ad-templatescommand families are removed from the CLI guide. Every remaining documented command was probed against atsbinary built from this branch.check-documentation.shis not included: main's rustdoc does not yet pass with warnings denied (29 intra-doc-link errors that Add full-surface documentation refresh spec #1049 fixes on rc).testing.mddocuments the two documentation checks that do run on main.scripts/README.mdlists only scripts that exist here; CI-gate links point atAGENTS.md(CLAUDE.mdis a symlink on main).CHANGELOG.md,README.md,TESTING.md, and auction README resolved to main's side;configuration.mdkeeps both main's initial-deployment steps and the refresh's secret-field migration guidance.Verification
cd docs && npm run lint && npm run format && npm run build— clean; the build fails on dead links and passed.cargo test --test documentation_snippets— the documented integration fixture compiles against main's core../scripts/smoke-axum.sh— boots main's Axum adapter end to end.docs/public/CNAMEintentionally does not exist, and the gitignoreddist/directory).Relation to the release branch
When
rc/202608merges, its versions of these files supersede this content where they differ (and restore the rc-only material such as the ad-templates CLI docs and the rustdoc aggregate). Merging this PR first publishes the docs site from main viadeploy-docs.yml.