diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 13:13:14 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 13:13:14 +0300 |
| commit | 2fcc13e8f3004d0a55382601b3ce141ea976f5af (patch) | |
| tree | 8241ea6c5b44486593952aac90524d06221a4632 /README.md | |
| parent | 7297946d395d6f4b133a76f2da9259cfbe65cd1e (diff) | |
| download | vyos-documentation-2fcc13e8f3004d0a55382601b3ce141ea976f5af.tar.gz vyos-documentation-2fcc13e8f3004d0a55382601b3ce141ea976f5af.zip | |
chore(readme): remove broken vale lint section
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)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 0 insertions, 13 deletions
@@ -102,16 +102,3 @@ $ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GO $ docker run --rm -it -p 8000:8000 -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make livehtml ``` -### Test the docs - -To test all files, run: - -```bash -$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale . -``` - -to test a specific file (e.g. `quick-start.rst`) - -```bash -$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale quick-start.rst -``` |