Skip to content

[AIR-3][AIS-3][BPC-3][RES-3]

Documentation Quick Start

Overview

Add a brief overview of this document here.

Table of Contents

This guide will help you quickly set up and start using the Anya Core documentation system.

Prerequisites

  • Python 3.8 or higher
  • pip (Python package manager)
  • Git

Setup

  1. Clone the repository (if you haven't already):
git clone https://github.com/anya-org/anya-core.git
cd anya-core
  1. Set up the documentation environment:
./scripts/setup_docs.sh

This will: - Create a Python virtual environment - Install MkDocs and required plugins - Set up the documentation structure

Viewing Documentation Locally

To view the documentation locally while you work:

./scripts/serve_docs.sh

This will start a local development server at http://127.0.0.1:8000 that automatically reloads when you make changes.

Creating New Documentation

  1. Use the template to create a new document:
cp docs/.template.md docs/guides/my-new-guide.md
  1. Edit the metadata at the top of the file:
---
title: "My New Guide"
description: "A brief description of this guide"
---

  1. Add your content using Markdown syntax.

  2. Update the navigation in mkdocs.yml if you want your new document to appear in the site navigation.

Documentation Standards

  • Follow the Markdown Style Guide
  • Include proper AI labeling at the top of each file
  • Keep lines under 100 characters
  • Use descriptive link text

Building for Production

To build the documentation for production:

./scripts/deploy_docs.sh

Select option 2 to deploy to GitHub Pages, or option 1 to preview the production build locally.

Troubleshooting

Common Issues

  1. Missing dependencies: 

    pip install -r requirements-docs.txt

  2. Broken links: 

    ./scripts/verify_docs.sh

  3. Formatting issues:

  4. Ensure all headers have blank lines before and after
  5. Check for trailing whitespace
  6. Verify all code blocks have language specified

Getting Help

Next Steps

See Also