fix: move authoring policy out of the docs tree - #7
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.
Deploying alauda-valkey with
|
| Latest commit: |
4903be1
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f537bbcc.alauda-valkey.pages.dev |
| Branch Preview URL: | https://fix-move-agent-docs.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
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.
Fixes the
doc-pr-build-valkeypipeline, which has been failing on every PR regardless of content (#4, #5, #6 all fail identically at taskbuild-docs, stepbuild, exit 1; every other task succeeds).Root cause
docs/agent/held internal authoring policy — but anything underdocs/is a documentation route. doom rendered those five files as/agent/*pages and SSG crashed on them:Why it never showed up locally
Two CI behaviours diverge from a local build:
--ignore.doom.config.ymlmarkedagent/**/*asinternalRoutesand thebuildscript passed--ignore=true, so the broken pages were skipped locally. Thebuild-docsstep runsyarn build-online-io(injected bymodify_build_config.xsh), which renders internal routes.install-dependenciesrunsyarn remove @alauda/doom→yarn add @alauda/doom→yarn up -R @alauda/doom, so it builds with the latest doom, not the pinned1.12.1. Newer doom adds a generated/agent/productspage in the same namespace — that's the page named in the log, and it does not exist in 1.12.1 at all.So
internalRoutes+--ignore=truewas masking a genuinely broken page rather than fixing it.The change
agent/, matchingredis-docs— which keeps its agent instructions andTERMINOLOGY_CANDIDATES.mdat the repository root and has never had adocs/agent/directory on any branch.AGENTS.md(and thereforeCLAUDE.md, a symlink) andllmstxt-config.yaml.internalRoutesand both--ignore=trueflags. With the files out of the docs tree they have nothing left to hide, and keeping them would restore the exact local/CI divergence that masked this.Verification
--ignore/agent/*yarn buildyarn lintdist/agent/is no longer produced at all, so the policy files are not published even as stubs.Related
release-2.0: fix: move authoring policy out of the docs tree (release-2.0) #8