Skip to content

fix: move authoring policy out of the docs tree - #7

Merged
chideat merged 1 commit into
masterfrom
fix/move-agent-docs
Aug 13, 2026
Merged

fix: move authoring policy out of the docs tree#7
chideat merged 1 commit into
masterfrom
fix/move-agent-docs

Conversation

@chideat

@chideat chideat commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

Fixes the doc-pr-build-valkey pipeline, which has been failing on every PR regardless of content (#4, #5, #6 all fail identically at task build-docs, step build, exit 1; every other task succeeds).

Root cause

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:

error  Page "/agent/products" SSG rendering failed.
       File: node_modules/@alauda/doom/lib/products/index.js
       TypeError: Cannot read properties of undefined (reading 'all_product_documentation')

Why it never showed up locally

Two CI behaviours diverge from a local build:

  1. CI does not pass --ignore. doom.config.yml marked agent/**/* as internalRoutes and the build script passed --ignore=true, so the broken pages were skipped locally. The build-docs step runs yarn build-online-io (injected by modify_build_config.xsh), which renders internal routes.
  2. CI discards the pinned doom version. install-dependencies runs yarn remove @alauda/doomyarn add @alauda/doomyarn up -R @alauda/doom, so it builds with the latest doom, not the pinned 1.12.1. Newer doom adds a generated /agent/products page 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=true was masking a genuinely broken page rather than fixing it.

The change

  • Moves the five files to a root-level agent/, matching redis-docs — which keeps its agent instructions and TERMINOLOGY_CANDIDATES.md at the repository root and has never had a docs/agent/ directory on any branch.
  • Updates the references in AGENTS.md (and therefore CLAUDE.md, a symlink) and llmstxt-config.yaml.
  • Drops internalRoutes and both --ignore=true flags. 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

build before after
doom 2.5.4 (what CI installs), no --ignore fails on /agent/* exit 0, 0 errors
pinned doom 1.12.1, yarn build exit 0, 0 errors
yarn lint 0 errors, 0 warnings

dist/agent/ is no longer produced at all, so the policy files are not published even as stubs.

Related

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.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying alauda-valkey with  Cloudflare Pages  Cloudflare Pages

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

View logs

@chideat
chideat added this pull request to the merge queue Aug 13, 2026
@chideat
chideat removed this pull request from the merge queue due to a manual request Aug 13, 2026
@chideat
chideat merged commit 4d59970 into master Aug 13, 2026
3 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.

1 participant