upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDanConwayDev <DanConwayDev@protonmail.com>2025-11-04 10:25:53 +0000
committerDanConwayDev <DanConwayDev@protonmail.com>2025-11-04 10:25:53 +0000
commit52bad9954cdddf55ab749fd0c6387edbc766632f (patch)
treed9dd2078b70a627a71d1adb9555cee83faec5cd0 /README.md
parentdb460efdd4cf34d3b6ac8c19b1b8f89f22bc279f (diff)
docs: use Diátaxis structure
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4672d8c..920d1d5 100644
--- a/README.md
+++ b/README.md
@@ -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
104We 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
104See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed architecture documentation and [docs/TEST_STRATEGY.md](docs/TEST_STRATEGY.md) for comprehensive testing approach. 115See [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