suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2026-07-04 11:25:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Explain how to build documentation locally

Browse Source
This commit is contained in:
Alessandro Griseta 2026-04-30 17:15:44 +01:00
parent cb97935554
commit 4faf82085b
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
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 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 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 ### Updating Operator Documentation
#### For Test-Generated Documentation #### For Test-Generated Documentation
@ -151,6 +164,7 @@ For documentation not in the master branch:
### Documentation Best Practices ### Documentation Best Practices
- **Write clear, concise examples** in test scenarios - **Write clear, concise examples** in test scenarios
- **Use meaningful variable names** in examples - **Use meaningful variable names** in examples
- **Include edge cases** and error conditions - **Include edge cases** and error conditions