Explain how to build documentation locally

This commit is contained in:
Alessandro Griseta 2026-04-30 17:15:44 +01:00
parent cb97935554
commit 4faf82085b

View File

@ -119,6 +119,19 @@ The project uses a documentation system that combines static headers with dynami
3. **Generated docs** are created in `pkg/yqlib/doc/*.md` by concatenating headers with test-generated content
4. **Documentation is synced** to the gitbook branch for the website
### Previewing documentation locally
```bash
uv venv
source .venv/bin/activate
uv pip install mkdocs-material
deactivate
source .venv/bin/activate
cp -r pkg/yqlib/doc/ mkdocs
mkdocs build
mkdocs serve
```
### Updating Operator Documentation
#### For Test-Generated Documentation
@ -151,6 +164,7 @@ For documentation not in the master branch:
### Documentation Best Practices
- **Write clear, concise examples** in test scenarios
- **Use meaningful variable names** in examples
- **Include edge cases** and error conditions
@ -226,4 +240,4 @@ Note: PRs with small changes (e.g. minor typos) may not be merged (see https://j
- **Check existing issues**: Search GitHub issues for similar problems
- **Create an issue**: If you can't find a solution, create a detailed issue
- **Ask questions**: Use GitHub Discussions for general questions
- **Join the community**: Check the project's community channels
- **Join the community**: Check the project's community channels