anya-core 1.2.0

Enterprise-grade Bitcoin Infrastructure Platform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

---
title: "Quickstart"
description: "Documentation for Quickstart"
last_updated: 2025-05-30
---

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

# Documentation Quick Start

## Overview

Add a brief overview of this document here.

## Table of Contents

- [Section 1](#section-1)
- [Section 2](#section-2)


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):

   ```bash
   git clone https://github.com/anya-org/anya-core.git
   cd anya-core
   ```

2. **Set up the documentation environment**:

   ```bash
   ./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:

```bash
./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:

   ```bash
   cp docs/.template.md docs/guides/my-new-guide.md
   ```

2. **Edit the metadata** at the top of the file:

   ```yaml
   ---
   title: "My New Guide"
   description: "A brief description of this guide"
   ---
   ```

3. **Add your content** using Markdown syntax.

4. **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](../standards/MARKDOWN_STYLE_GUIDE.md)
- 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:

```bash
./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**:
   ```bash
   pip install -r requirements-docs.txt
   ```

2. **Broken links**:
   ```bash
   ./scripts/verify_docs.sh
   ```

3. **Formatting issues**:
   - Ensure all headers have blank lines before and after
   - Check for trailing whitespace
   - Verify all code blocks have language specified

## Getting Help

- Check the [Documentation System Guide](../DOCUMENTATION_SYSTEM.md)
- Review the [Markdown Style Guide](../standards/MARKDOWN_STYLE_GUIDE.md)
- [Open an issue](https://github.com/anya-org/anya-core/issues) if you need assistance

## Next Steps

- [Explore the API Reference](../api/README.md)
- [Read the Architecture Documentation](../architecture/README.md)
- [Learn about Contribution Guidelines](../../CONTRIBUTING.md)

## See Also

- [Related Document](#related-document)