fix: move authoring policy out of the docs tree (release-2.0) - #8
Merged
Conversation
docs/agent/ held internal authoring policy, but anything under docs/ is a documentation route. doom rendered those five files as /agent/* pages and SSG crashed on them, which is why doc-pr-build-valkey failed on every PR regardless of its content. The failure was invisible locally because doom.config.yml marked agent/**/* as internalRoutes and the build script passed --ignore=true. CI does not pass that flag: build-docs runs `yarn build-online-io`, which renders internal routes. CI also discards the pinned doom version -- install-dependencies runs `yarn remove @alauda/doom && yarn add @alauda/doom` -- so it builds with the latest doom, which adds a generated /agent/products page in the same namespace. That page is the one named in the pipeline log. Moves the files to a root-level agent/ directory, matching redis-docs, which keeps its agent instructions and TERMINOLOGY_CANDIDATES.md at the repository root and has never had a docs/agent/ directory. With the files out of the docs tree, internalRoutes and --ignore=true have nothing left to hide, so both are removed. Keeping them would restore the local/CI divergence that masked this. Verified against doom 2.5.4, the version CI installs: the build fails on /agent/* before this change and completes with zero errors after. Also green on the pinned 1.12.1, and dist/agent/ is no longer produced. (cherry picked from commit 4903be1)
Deploying alauda-valkey with
|
| Latest commit: |
083faba
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://365c8633.alauda-valkey.pages.dev |
| Branch Preview URL: | https://fix-move-agent-docs-release.alauda-valkey.pages.dev |
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.
Cherry-pick of #7 to
release-2.0. Applied cleanly — the affected files are identical on both branches.Why
docs/agent/held internal authoring policy, but anything underdocs/becomes a documentation route. doom rendered those five files as/agent/*pages and SSG crashed on them, failingdoc-pr-build-valkeyon every PR against this branch (#4, #6) regardless of content.It was invisible locally because
internalRoutes: agent/**/*plus--ignore=truein the build script skipped those pages — and CI passes no such flag, and additionally replaces the pinned doom1.12.1with the latest release.The change
docs/agent/→ root-levelagent/, matchingredis-docs.AGENTS.md(andCLAUDE.md, a symlink) andllmstxt-config.yaml.internalRoutesand both--ignore=trueflags dropped — dead once the files are out of the docs tree.Verification on this branch
yarn build(now plaindoom build) — exit 0, 0 errorsyarn lint— 0 errors, 0 warnings/agent/*before, clean after.See #7 for the full analysis.