mirror of
https://github.com/priyanshujain/sanderling.git
synced 2026-10-02 11:07:10 +00:00
docs: pandoc-based site and v0.1.0 groundwork (#5)
* chore(prose): remove em-dashes from config files * chore(prose): remove em-dashes from android sdk config * docs(spec-api): remove em-dash from README * fix(doctor): reword sidecar-jar error without em-dash * test(sidecar): reword assertion message without em-dash * docs: add CLAUDE.md with project conventions * build: add docs target for pandoc site * docs(site): add pandoc template and stylesheet * docs(site): add pandoc build script * docs(site): add landing pages * docs(manual): add getting-started * docs(manual): add writing-specs * docs(manual): add runs * docs(manual): add cli reference * docs(dev): add design principles * docs(dev): add architecture * ci: deploy docs site to github pages * docs: rewrite README as entry point to docs site
This commit is contained in:
25 files changed
+920
-56
No files matched your search
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: Development
|
||||
---
|
||||
|
||||
# Development
|
||||
|
||||
- [Design principles](./design-principles.html)
|
||||
- [Architecture](./architecture.html)
|
||||
- v0.1.0 scope: [issue #4](https://github.com/priyanshujain/uatu/issues/4)
|
||||
|
||||
## 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
|
||||
```
|
||||
Reference in new issue
Block a user