Skip to content

fix: move authoring policy out of the docs tree (release-2.0) #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chideat merged 1 commit into from
Aug 13, 2026
Merged

fix: move authoring policy out of the docs tree (release-2.0) #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@

Before writing or changing technical documentation, read:

- `docs/agent/TECHNICAL_WRITING_POLICY.md`
- `docs/agent/TERMINOLOGY.md`
- `docs/agent/ARCHITECTURE_FACTS.md`
- `docs/agent/SOURCE_POLICY.md`
- `agent/TECHNICAL_WRITING_POLICY.md`
- `agent/TERMINOLOGY.md`
- `agent/ARCHITECTURE_FACTS.md`
- `agent/SOURCE_POLICY.md`

These live at the repository root, outside `docs/`. Anything under `docs/` is
rendered as a documentation route and published; authoring policy must not be.

Treat `TERMINOLOGY.md` as the canonical vocabulary. Verify product claims against
the current `valkey-operator` `origin/master` source, generated CRDs, and packaged
Expand Down
0 docs/agent/ARCHITECTURE_FACTS.md → agent/ARCHITECTURE_FACTS.md
View file
Open in desktop
File renamed without changes.
0 docs/agent/CONTENT_AUDIT.md → agent/CONTENT_AUDIT.md
View file
Open in desktop
File renamed without changes.
0 docs/agent/SOURCE_POLICY.md → agent/SOURCE_POLICY.md
View file
Open in desktop
File renamed without changes.
0 docs/agent/TECHNICAL_WRITING_POLICY.md → agent/TECHNICAL_WRITING_POLICY.md
View file
Open in desktop
File renamed without changes.
0 docs/agent/TERMINOLOGY.md → agent/TERMINOLOGY.md
View file
Open in desktop
File renamed without changes.
2 changes: 0 additions & 2 deletions doom.config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,3 @@ lang: en
api:
crds:
- docs/shared/crds/*.yaml
internalRoutes:
- agent/**/*
2 changes: 1 addition & 1 deletion llmstxt-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ exclude_patterns:
- "README.md"
- "**/.DS_Store"
# Authoring policy for agents, not product documentation.
- "docs/agent/**"
- "agent/**"
- "AGENTS.md"
- "CLAUDE.md"
grouping_base_path: "docs/en"
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
},
"scripts": {
"dev": "doom dev",
"build": "doom --ignore=true build",
"build": "doom build",
"lint": "doom lint",
"serve": "doom --ignore=true serve",
"serve": "doom serve",
"translate": "doom translate"
},
"packageManager": "yarn@4.9.4"
Expand Down