summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2026-05-14docs: refresh README + AGENTS source-format claim for circinusYuriy Andamasov
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)
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-07chore(readme): remove broken vale lint sectionYuriy Andamasov
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)
2025-10-21readme: Update information about branchesDaniil Baturin
2024-04-18readme: Improve Docker instructionsMatthew Kobayashi
2024-04-16change master to current branch namerebortg
2023-09-10Update README for missing dependenciesYuxiang Zhu
2023-08-04Update links and info in the READMEDaniil Baturin
2023-02-12T5001: Replace links to the phabricator siteChristian Breunig
Replace links to the phabricator site from https://phabricator.vyos.net to https://vyos.dev
2022-04-17minor documentation change - I think this is what is known as an open compoundLove Dufva
2022-02-12Remove obsolete information about native documentation generationerkin
2021-02-06README: add link to old WikiChristian Poessinger
2021-02-05README: explain documentation branching schemeChristian Poessinger
2021-01-23Fix typos in READMEerkin
2020-08-20remove redundant linkJoseph Turner
it just redirects to docs.vyos.io, seems pointless to list to me
2020-07-07Fix setup instructions for documentation buildAlfa80
2020-02-03update build documentationThomas Mangin
The current requirements.txt does not include sphinx-autobuild (it is part of the python3-sphinx on buster) sphinx-rtd-theme is available as a debian package
2020-01-15Fix native build layoutclient
2020-01-15Declare python3 requirements for native build, update relevant sectionclient
2019-12-07README: fix docker tag nameChristian Poessinger
2019-11-17README: update info on ReadTheDocsChristian Poessinger
2019-11-09README: reword instructions to match DockerhubChristian Poessinger
2019-10-14T1731: 1st version to test valeRobert Göhler
2019-04-24fix windows examplePeter Magnusson
2019-04-24Add sphinx-autobuild to dockerPeter Magnusson
2019-04-20Docker: update Dockerfile and descriptionChristian Poessinger
2019-03-24Fix missing lettersAli
2019-01-18Added example for how to runcontainer using Windows PowerShellkmpm
2018-10-07Update README.md with Docker build instructionsChristian Poessinger
2018-10-03Add README.mdChristian Poessinger