From 6a5be2a4ee60541e991ebeda3491523c51b37ae2 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 13 May 2026 21:14:46 +0000 Subject: docs: hard-wrap AGENTS lines flagged by review Agent-Logs-Url: https://github.com/vyos/vyos-documentation/sessions/7dabfd4c-09a5-4af5-99c8-fb4a64329520 Co-authored-by: andamasov <12631358+andamasov@users.noreply.github.com> --- AGENTS.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 21b49b79..e5b3a76e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -4,9 +4,16 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co ## Project -VyOS user documentation, built with Sphinx and hosted on Read the Docs at https://docs.vyos.io. This branch (`sagitta`, 1.4.x previous LTS) is migrated to MyST Markdown (`.md`) except for two pages with known converter issues that stayed in RST: `docs/cli.rst` and `docs/installation/cloud/aws.rst`. `source_suffix` in `docs/conf.py` is `['.rst', '.md']`. Both formats are first-class to Sphinx. +VyOS user documentation, built with Sphinx and hosted on Read the Docs at +https://docs.vyos.io. This branch (`sagitta`, 1.4.x previous LTS) is migrated +to MyST Markdown (`.md`) except for two pages with known converter issues that +stayed in RST: `docs/cli.rst` and `docs/installation/cloud/aws.rst`. +`source_suffix` in `docs/conf.py` is `['.rst', '.md']`. Both formats are +first-class to Sphinx. -Pre-migration RST shadows of converted pages are archived under `docs/_rst_legacy/` for reference only — they are excluded from the build, not consulted by Sphinx, and must not be edited. +Pre-migration RST shadows of converted pages are archived under +`docs/_rst_legacy/` for reference only — they are excluded from the build, +not consulted by Sphinx, and must not be edited. ## Build @@ -75,12 +82,17 @@ Mergify is configured at the org level (no `.mergify.yml` in the repo). The PR t ### Source files - `docs//.md` — canonical MD source for migrated pages (most of the tree). -- The two RST-only pages on this branch: `docs/cli.rst` and `docs/installation/cloud/aws.rst`. Both stayed RST due to converter issues at MyST-migration time and have not been revisited since. +- The two RST-only pages on this branch: `docs/cli.rst` and + `docs/installation/cloud/aws.rst`. Both stayed RST due to converter issues + at MyST-migration time and have not been revisited since. - `docs/_include/.txt` — shared RST snippets included into MyST pages via `cmdincludemd`. Their content is parsed as RST so the legacy templates keep working unchanged. -- `docs/_rst_legacy//rst-.rst` — archived pre-migration RST shadows of converted pages. Excluded from the Sphinx build and from the Context7 index. Reference only. +- `docs/_rst_legacy//rst-.rst` — archived pre-migration RST + shadows of converted pages. Excluded from the Sphinx build and from the + Context7 index. Reference only. **Editing rules:** -- Existing migrated page (has `.md`): edit the `.md`. Do not touch the archived shadow under `_rst_legacy/`. +- Existing migrated page (has `.md`): edit the `.md`. Do not touch the + archived shadow under `_rst_legacy/`. - One of the two remaining RST-only pages above: edit the `.rst`. - New page: write it as `.md` from the start. The `md-` prefix that earlier MyST migration commits used is gone — never add it. -- cgit v1.2.3