mirror of
https://github.com/priyanshujain/sanderling.git
synced 2026-10-02 19:17:10 +00:00
pj
991c583eb9
* docs(manual): add introduction page * docs(manual): rewrite getting started as guided first run * docs(manual): rewrite writing specs as a folio tutorial * docs(manual): document missing spec API in reference * docs(manual): plain-language rewrite of runs page * docs: real introductions on index pages and README * fix(docs): sibling links from directory-style pages need ../ * fix(docs): correct sampling and restart-cost claims to match implementation * docs: nav lists Introduction and Case study; roadmap points to milestone * docs(manual): make getting started target the reader's own app, not Folio * docs(manual): add Folio case study page * docs: point manual navigation at the case study * docs(readme): lead with the case study, fix roadmap link * docs: roadmap links to milestone, sync clear-data default and cross-links
22 lines
411 B
Markdown
22 lines
411 B
Markdown
---
|
|
title: Development
|
|
---
|
|
|
|
# Development
|
|
|
|
- [Design principles](./design-principles/)
|
|
- [Architecture](./architecture/)
|
|
- v0.1.0 scope: [milestone #1](https://github.com/priyanshujain/sanderling/milestone/1)
|
|
|
|
## Building the docs site locally
|
|
|
|
```
|
|
make docs
|
|
```
|
|
|
|
Outputs to `build/site/`. Requires [pandoc](https://pandoc.org/) on your PATH. Preview with:
|
|
|
|
```
|
|
cd build/site && python3 -m http.server 8000
|
|
```
|