Documentation

Garyon uses DocFX for API reference generation and Markdown-based guides.

What Lives Under docs/

  • docfx.json contains the DocFX configuration.
  • toc.yml defines the site navigation.
  • guides/ contains the user guides.
  • build-docs.ps1 and build-docs.sh build the site locally.
  • api/ and _site/ are generated by DocFX.

Build Locally

From the repository root:

.\docs\build-docs.ps1
.\docs\build-docs.ps1 -Serve

chmod +x docs/build-docs.sh
./docs/build-docs.sh
./docs/build-docs.sh --serve

Manual DocFX commands from the repository root:

docfx docs/docfx.json
docfx docs/docfx.json --serve
docfx metadata docs/docfx.json
docfx build docs/docfx.json

Structure

docs/
├── docfx.json
├── toc.yml
├── index.md
├── QUICK_REFERENCE.md
├── DOCUMENTATION.md
├── README.md
├── build-docs.ps1
├── build-docs.sh
├── guides/
│   ├── toc.yml
│   ├── index.md
│   └── *.md
├── api/
└── _site/

Contributing

  1. Add or update XML documentation for public APIs.
  2. Add or update the matching guide in docs/guides/.
  3. Register the guide in docs/guides/toc.yml.
  4. Run docfx docs/docfx.json before committing.

Deployment

The GitHub Actions workflow at .github/workflows/docs.yml builds the site from docs/docfx.json and publishes the generated output.

Edit this page