diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 12 insertions, 1 deletions
| @@ -99,9 +99,20 @@ Environment variables (see `.env.example`): | |||
| 99 | - `NGIT_RELAY_DATA_PATH`: Path to store Nostr events | 99 | - `NGIT_RELAY_DATA_PATH`: Path to store Nostr events |
| 100 | - `NGIT_BIND_ADDRESS`: Server bind address (default: `127.0.0.1:8080`) | 100 | - `NGIT_BIND_ADDRESS`: Server bind address (default: `127.0.0.1:8080`) |
| 101 | 101 | ||
| 102 | ## Documentation | ||
| 103 | |||
| 104 | We use the **[Diátaxis](https://diataxis.fr/)** framework for documentation: | ||
| 105 | |||
| 106 | - **[Tutorials](docs/tutorials/)** - Learn by doing (Getting Started, First Audit) | ||
| 107 | - **[How-To Guides](docs/how-to/)** - Solve specific problems (Deploy, Configure) | ||
| 108 | - **[Reference](docs/reference/)** - Look up technical details (Config, Protocols) | ||
| 109 | - **[Explanation](docs/explanation/)** - Understand concepts (Architecture, Decisions) | ||
| 110 | |||
| 111 | **Start here:** [Documentation Index](docs/README.md) | ||
| 112 | |||
| 102 | ## Development | 113 | ## Development |
| 103 | 114 | ||
| 104 | See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed architecture documentation and [docs/TEST_STRATEGY.md](docs/TEST_STRATEGY.md) for comprehensive testing approach. | 115 | See [Architecture Overview](docs/explanation/architecture.md) for system design and [Test Strategy](docs/reference/test-strategy.md) for testing approach. |
| 105 | 116 | ||
| 106 | ```bash | 117 | ```bash |
| 107 | # Run tests | 118 | # Run tests |