<feed xmlns='http://www.w3.org/2005/Atom'>
<title>vyos-documentation.git/README.md, branch mergify/bp/circinus/pr-2188</title>
<subtitle>VyOS readthedocs (mirror of https://github.com/vyos/vyos-documentation.git)
</subtitle>
<id>https://git.amelek.net/vyos/vyos-documentation.git/atom?h=mergify%2Fbp%2Fcircinus%2Fpr-2188</id>
<link rel='self' href='https://git.amelek.net/vyos/vyos-documentation.git/atom?h=mergify%2Fbp%2Fcircinus%2Fpr-2188'/>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/'/>
<updated>2026-08-20T13:14:18+00:00</updated>
<entry>
<title>docs: update AGENTS.md bot-review section to current CodeRabbit reality (#2188)</title>
<updated>2026-08-20T13:14:18+00:00</updated>
<author>
<name>Yuriy Andamasov</name>
<email>yuriy@vyos.io</email>
</author>
<published>2026-08-14T14:41:58+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=34f93dc25888f31cb0009d6b70266c695cb444b1'/>
<id>urn:sha1:34f93dc25888f31cb0009d6b70266c695cb444b1</id>
<content type='text'>
The "Bot review workflow" section documented a manual-invocation flow
that no longer matches how this repo works.

Stale claims removed:

- "Auto-reviews are disabled on this repo — both bots are triggered
  manually." CodeRabbit auto-review is enabled here; the per-repo
  disable override was lifted.
- The 5-step workflow instructing contributors to comment
  `@copilot review` on a draft, iterate until Copilot is silent, then
  flip to ready and comment `@coderabbitai review`.
- The two-row bot table pairing Copilot with drafts and CodeRabbit
  with ready PRs.

Current reality documented instead:

- CodeRabbit reviews automatically on the draft -&gt; ready flip and on
  every subsequent push; drafts are always skipped.
- CodeRabbit commonly edits its walkthrough comment in place rather
  than posting a new one, so the absence of a new comment is not the
  absence of a review.
- A rate-limited CodeRabbit silently drops that review; commenting
  `@coderabbitai review` after the window resets is the only case
  where a manual trigger is appropriate.
- Copilot is no longer part of the workflow and should not be
  invoked. Threads from a manual invocation by someone else are
  addressed like any other reviewer feedback.

Also adds the missing AI Validation entry to the CI list: it
cross-checks changed docs Markdown against the vyos-1x source tree for
the corresponding branch and posts inline plus summary review
comments, runs only when a PR touches docs Markdown, and skips when
the required repository secrets are unavailable or the PR is a
Mergify-authored backport.

README.md's pointer to the contributor guide is updated in the same
pass to drop Copilot from the named workflow. Note that
.github/copilot-instructions.md is a symlink to AGENTS.md, so it
picks up the change automatically.

🤖 Generated by [robots](https://vyos.io)

(cherry picked from commit c9fb0c0b4dd8e13ac841ee88fee8b4c6649098c5)

# Conflicts:
#	AGENTS.md
#	README.md
</content>
</entry>
<entry>
<title>docs: refresh README + AGENTS source-format claim for circinus</title>
<updated>2026-05-13T21:03:00+00:00</updated>
<author>
<name>Yuriy Andamasov</name>
<email>yuriy@vyos.io</email>
</author>
<published>2026-05-13T21:03:00+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=1bd99f3e69401b9e26dba5d1c7605bd761f85dbe'/>
<id>urn:sha1:1bd99f3e69401b9e26dba5d1c7605bd761f85dbe</id>
<content type='text'>
Adapted from PR #2014 on rolling, tailored to this branch's actual
state.

This branch (circinus, 1.5.x LTS) is mostly migrated to MyST
Markdown. 11 RST pages remain in the build alongside the .md set:

- docs/changelog/index.rst + docs/changelog/{1.2.1..1.2.6, 1.3,
  1.4, 1.5}.rst (auto-generated; stayed RST)
- docs/automation/terraform/terraformvyos.rst

source_suffix in docs/conf.py is `['.rst', '.md']` to cover both.

Changes:

- README.md: new `## Source format` section naming the legacy 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 enumerate the 11 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 (the inline
move on rolling at 2026-05-10 has not been backported to circinus).

🤖 Generated by [robots](https://vyos.io)
</content>
</entry>
<entry>
<title>docs: refresh README + sweep stale `current` refs in AGENTS.md</title>
<updated>2026-05-10T15:06:54+00:00</updated>
<author>
<name>Yuriy Andamasov</name>
<email>yuriy@vyos.io</email>
</author>
<published>2026-05-10T15:06:54+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=19d6c427a03cac5be39acf85e4a3c76be9c317e1'/>
<id>urn:sha1:19d6c427a03cac5be39acf85e4a3c76be9c317e1</id>
<content type='text'>
- 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)
</content>
</entry>
<entry>
<title>chore(readme): remove broken vale lint section</title>
<updated>2026-05-07T10:38:17+00:00</updated>
<author>
<name>Yuriy Andamasov</name>
<email>yuriy@vyos.io</email>
</author>
<published>2026-05-07T10:13:14+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=386f32e1d7a47332106d72626b05cedb21d64014'/>
<id>urn:sha1:386f32e1d7a47332106d72626b05cedb21d64014</id>
<content type='text'>
The Test-the-docs section documented running vale through Docker, but
vale is not in the Docker image, no .vale.ini exists, and no styles
directory is present. CI uses vyoslinter (doc-linter.py) for linting.

🤖 Generated by [robots](https://vyos.io)

(cherry picked from commit 2fcc13e8f3004d0a55382601b3ce141ea976f5af)
</content>
</entry>
<entry>
<title>readme: Update information about branches</title>
<updated>2025-10-21T11:28:18+00:00</updated>
<author>
<name>Daniil Baturin</name>
<email>daniil@baturin.org</email>
</author>
<published>2025-10-21T11:26:33+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=abe1b22d41440297d719e543d77f4186def32930'/>
<id>urn:sha1:abe1b22d41440297d719e543d77f4186def32930</id>
<content type='text'>
</content>
</entry>
<entry>
<title>readme: Improve Docker instructions</title>
<updated>2024-04-18T06:47:03+00:00</updated>
<author>
<name>Matthew Kobayashi</name>
<email>matthew@kobayashi.au</email>
</author>
<published>2024-04-18T06:47:03+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=498a960a0553c7d496fc02cea10ff336f5143d72'/>
<id>urn:sha1:498a960a0553c7d496fc02cea10ff336f5143d72</id>
<content type='text'>
</content>
</entry>
<entry>
<title>change master to current branch name</title>
<updated>2024-04-16T19:28:39+00:00</updated>
<author>
<name>rebortg</name>
<email>github@ghlr.de</email>
</author>
<published>2024-04-16T19:28:39+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=a5fcebd11b19577e082c344fd2532e8689719d9e'/>
<id>urn:sha1:a5fcebd11b19577e082c344fd2532e8689719d9e</id>
<content type='text'>
</content>
</entry>
<entry>
<title>Update README for missing dependencies</title>
<updated>2023-09-10T12:37:00+00:00</updated>
<author>
<name>Yuxiang Zhu</name>
<email>vfreex@gmail.com</email>
</author>
<published>2023-09-10T12:37:00+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=4e3492804e32bc317a6f1fa1a38f75557e5853fe'/>
<id>urn:sha1:4e3492804e32bc317a6f1fa1a38f75557e5853fe</id>
<content type='text'>
</content>
</entry>
<entry>
<title>Update links and info in the README</title>
<updated>2023-08-04T16:57:19+00:00</updated>
<author>
<name>Daniil Baturin</name>
<email>daniil@vyos.io</email>
</author>
<published>2023-08-04T16:57:19+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=2d78e7c72dcb006e9a8a9ccc4f263e84c7a12df8'/>
<id>urn:sha1:2d78e7c72dcb006e9a8a9ccc4f263e84c7a12df8</id>
<content type='text'>
</content>
</entry>
<entry>
<title>T5001: Replace links to the phabricator site</title>
<updated>2023-02-12T20:05:22+00:00</updated>
<author>
<name>Christian Breunig</name>
<email>christian@breunig.cc</email>
</author>
<published>2023-02-12T20:05:22+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-documentation.git/commit/?id=27512c94e62ec1883aafc97abafbd09d69ef1896'/>
<id>urn:sha1:27512c94e62ec1883aafc97abafbd09d69ef1896</id>
<content type='text'>
Replace links to the phabricator site from https://phabricator.vyos.net to
https://vyos.dev
</content>
</entry>
</feed>
