summaryrefslogtreecommitdiff
path: root/AGENTS.md
AgeCommit message (Collapse)Author
2026-05-14docs(agents): finish wrapping the 3 sagitta lines auto-wrap missedYuriy Andamasov
The previous auto-wrap commit (6a5be2a4) wrapped the `## Project` prose but left 3 bullet lines in my diff still over 80 chars: - Source files L84 (90 chars) — `<page>.md ... most of the tree`. - Source files L89 (176 chars) — `_include/<name>.txt` description. - CI L226 (154 chars) — vyoslinter bullet. Wrapped each to ≤80 chars to keep new content consistent with the documented 80-char rule. 🤖 Generated by [robots](https://vyos.io)
2026-05-13docs: hard-wrap AGENTS lines flagged by reviewcopilot-swe-agent[bot]
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>
2026-05-14ci: inline doc-linter on sagitta to match rollingYuriy Andamasov
The lint workflow on this branch referenced `vyos/.github/.github/workflows/lint-doc.yml@feature/T6349-reusable-workflows`, which doesn't exist in `vyos/.github` (no commit found for that ref). The reusable-workflow `uses:` line has been silently failing (no `doc-lint` check on recent sagitta PRs). Mirror rolling's approach (inlined 2026-05-10): - Add `scripts/doc-linter.py` in this repo. Sourced from PR #2014's HEAD on rolling (the version that includes the `is_docs_path()` docs/-only scope guard so repo-root meta files like AGENTS.md and README.md are out of scope, plus the realpath / narrow-exception / Ruff fixes from that PR's review pass). - Replace `.github/workflows/lint-doc.yml` with an in-repo workflow that runs `python scripts/doc-linter.py "$FILES_MODIFIED"` against the changed-file list from `trilom/file-changes-action`. Same job shape as rolling. - Update the `## Lint` and `## CI` bullets in AGENTS.md to point at the in-repo paths. This restores actual lint coverage on sagitta PRs and keeps the toolchain identical across rolling / circinus / sagitta. Behavior on the 2 remaining `.rst` pages (cli.rst, aws.rst) is unchanged — the linter's SUPPORTED_EXTS already covers `.md`, `.rst`, and `.txt`. 🤖 Generated by [robots](https://vyos.io)
2026-05-14docs: refresh README + AGENTS source-format claim for sagittaYuriy Andamasov
Adapted from PR #2014 on rolling, tailored to this branch's actual state. This branch (sagitta, 1.4.x previous LTS) is migrated to MyST Markdown 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']` to cover both. Changes: - README.md: new `## Source format` section naming the two stuck RST pages, pointing at the `_rst_legacy/` archive, and noting the MyST-fence form for VyOS command directives in .md pages. The `## Contributing` blurb drops the now-imprecise "MyST for migrated pages, RST for the rest" phrasing. - AGENTS.md: `## Project` and `### Source files` sections updated to name the two remaining RST pages explicitly so contributors know which files are still RST and which to write as MyST. Linter origin claim ("doc-linter.py from the vyos/.github repo") left intact — that script is NOT inlined on this branch. 🤖 Generated by [robots](https://vyos.io)
2026-05-10docs: refresh README + sweep stale `current` refs in AGENTS.mdYuriy Andamasov
- Rewrite README.md: drop Python 2 install dance, drop `sphinx-panels` (removed years ago), drop `sudo pip install` antipattern, replace with venv + requirements.txt path. Refresh the branch table to current naming, point contributors at AGENTS.md for the full guide. Refresh the docs status badge to reference `rolling` (was `latest`). - AGENTS.md: replace remaining `current` branch references with `rolling` in the branch table, the "PRs target …" line, and the RTD layout table Branch column. The default branch was renamed `current` → `rolling` on 2026-05-10 (commit 8dbf8b05 only swept CI). 🤖 Generated by [robots](https://vyos.io)
2026-05-10chore: remove RST swap mechanism, archive rst-*.rst under docs/_rst_legacy/Yuriy Andamasov
The swap mechanism (RST-as-fallback for migrated MD pages) is dormant — docs/_rst_overrides.txt has been empty since the MyST flip trio landed. The mechanism's surface area is dead weight and the rst-*.rst shadows scattered across the source tree cause Context7's parser to misclassify the project as RST. Sibling PRs: - yuriy/remove-rst-swap-mechanism (rolling) - yuriy/remove-rst-swap-mechanism-circinus Changes: - Move 210 rst-*.rst shadow files into docs/_rst_legacy/ preserving subdirectory structure. They remain in the repo for reference; Sphinx excludes the folder via exclude_patterns. - Strip swap_sources.py invocation from docs/Makefile. - Strip rst-*.rst exclude entry and the _md_exclude.txt loader from docs/conf.py; replace with a single _rst_legacy exclude. - Delete scripts/swap_sources.py, tests/test_swap_sources.py, docs/_rst_overrides.txt. - Update AGENTS.md: drop the "RST override mechanism" section and the test-runner snippet for the deleted test. Note: .readthedocs.yml on sagitta has no jobs: block to remove (the swap was wired only at build-time via the Makefile chain on this branch). Verified: sphinx-build -b html with --keep-going produces identical warning set (409 unique — pre-existing cli.rst/aws.rst title-level warnings on this branch), identical sitemap entry count (215), identical llms.txt entry count (23), zero rst-* URLs in any artifact. 🤖 Generated by [robots](https://vyos.io)
2026-05-07general: T8595: switch CLAUDE.md to AGENTS.md (+ Copilot symlink)Yuriy Andamasov
(cherry picked from commit 9d84dabbe420f77ea61e125544556c7769bfb20b) # Conflicts: # .github/copilot-instructions.md