diff options
| author | Claude <noreply@anthropic.com> | 2026-05-13 09:22:40 +0000 |
|---|---|---|
| committer | Claude <noreply@anthropic.com> | 2026-05-13 09:22:40 +0000 |
| commit | dd031e648850ed4409512548fa09bd0ca8d8060e (patch) | |
| tree | 37636448d13699d591a1c225fed47e8167ce61ca /scripts | |
| parent | bfc681807ab2eafe3bfcea55be148deaba29f298 (diff) | |
| download | vyos-documentation-dd031e648850ed4409512548fa09bd0ca8d8060e.tar.gz vyos-documentation-dd031e648850ed4409512548fa09bd0ca8d8060e.zip | |
docs(readme): reflect completed MyST migration
The MyST migration is complete: source_suffix in docs/conf.py is now
['.md'] only, all canonical pages are .md, and the pre-migration RST
originals are archived under docs/_rst_legacy/ (excluded from the
build). Update the README accordingly:
- Add a 'Source format' section stating pages are MyST Markdown and
pointing at the _rst_legacy/ archive so newcomers know not to edit
it. Mention that the VyOS command directives are written as MyST
fenced blocks via myst_fence_as_directive, and that docs/_include/
*.txt snippets stay RST because cmdincludemd parses their content
as RST (per 9c815d6).
- Drop the stale 'MyST Markdown for migrated pages, RST for the rest'
line from the Contributing section; rephrase to point at the actual
topics AGENTS.md covers today (MyST conventions, command directives,
linter suppression markers, Copilot/CodeRabbit workflow).
Diffstat (limited to 'scripts')
0 files changed, 0 insertions, 0 deletions
