diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 13:34:15 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 13:34:15 +0300 |
| commit | 939496f90f4268b240b2b56bcb527adc4f3a5797 (patch) | |
| tree | 67377eb9a93cda7d3cffc9294d8666b06d7923a7 | |
| parent | ac07ed8408e14aed4478dc64ffb057bd71d2a447 (diff) | |
| download | vyos-documentation-939496f90f4268b240b2b56bcb527adc4f3a5797.tar.gz vyos-documentation-939496f90f4268b240b2b56bcb527adc4f3a5797.zip | |
docs(claude-md): fix llms.txt backtick, redirect aliases, template path examples
- Wrap llms.txt in backticks where missing (formatting consistency)
- Expand redirect alias patterns to explicit destinations (/en/circinus/* → /en/1.5/ etc.)
- Use exact template paths (vpp/index.md, contributing/index.md) in branch-specific example
- Add RTD table re-verification note
🤖 Generated by [robots](https://vyos.io)
| -rw-r--r-- | CLAUDE.md | 13 |
1 files changed, 8 insertions, 5 deletions
@@ -191,7 +191,7 @@ A PR that both adds and removes TODOs is not contradictory; intent matters. Both files are regenerated on every `html` and `readthedocs` builder run. The `dirhtml` builder is intentionally skipped — production publishes -only via `html`/`readthedocs`, and we don't render llms.txt for builds +only via `html`/`readthedocs`, and we don't render `llms.txt` for builds we don't ship. Local `make dirhtml` is a developer convenience and won't emit `llms.txt`. @@ -209,11 +209,13 @@ Files are shipped at the docs root for each version When adding new top-level sections to the docs, add a corresponding bullet in `docs/_templates/llms.txt.j2`. Branch-specific differences (e.g. sagitta has -no `vpp/` or `contributing/index`) live in that branch's copy of the template. +no `vpp/index.md` or `contributing/index.md`) live in that branch's copy of the template. ## Read the Docs Layout -RTD slugs as of 2026-05-04 (verified via API): +RTD slugs as of 2026-05-04 (verified via API). Re-verify via the RTD +Versions API (project `vyos`) and update the date stamp before editing this +table. | Slug | Verbose | Branch | Role | |---|---|---|---| @@ -224,8 +226,9 @@ RTD slugs as of 2026-05-04 (verified via API): URL-level redirect aliases (resolve to the canonicals above): `/en/latest/* → /en/rolling/`, `/en/lts/* → /en/1.5/`, -`/en/stable/* → /en/lts/`, `/en/circinus*`, `/en/sagitta*`, -`/en/equuleus*`, `/en/crux*` → numeric slugs. +`/en/stable/* → /en/lts/`, `/en/circinus/* → /en/1.5/`, +`/en/sagitta/* → /en/1.4/`, `/en/equuleus/* → /en/1.3/`, +`/en/crux/* → /en/1.2/`. `html_baseurl` per branch must point at the canonical (numeric or `rolling`), not the alias, so `<link rel="canonical">` and the sitemap match what RTD |