|
| 1 | +# theprototype.app docs |
1 | 2 |
|
2 | | -Windows Python install |
3 | | -Download latest embeded |
4 | | -https://www.python.org/downloads/windows/ |
5 | | -https://bootstrap.pypa.io/get-pip.py |
6 | | -set PATH=%PATH%; |
7 | | - |
8 | | -Configuring locally |
9 | | - |
10 | | -``` bash |
11 | | -python -m virtualenv ./venv |
12 | | -.\venv\Scripts\activate.bat |
13 | | -pip install mkdocs-material mkdocs-git-revision-date-plugin |
14 | | -mkdocs serve |
15 | | -gh-deploy --force |
16 | | -``` |
| 3 | +User and SDK documentation for [theprototype.app](https://theprototype.app), built with |
| 4 | +[MkDocs Material](https://squidfunk.github.io/mkdocs-material/) and published to |
| 5 | +**[docs.theprototype.app](https://docs.theprototype.app)**. |
| 6 | + |
| 7 | +## Branches |
| 8 | + |
| 9 | +| Branch | Role | |
| 10 | +|---|---| |
| 11 | +| `docs` | **default** — the source. Markdown under `docs/`, config in `mkdocs.yml`, theme overrides in `overrides/`. | |
| 12 | +| `gh-pages` | build output, written by `mkdocs gh-deploy`. Never edit by hand. | |
| 13 | + |
| 14 | +The custom domain comes from the `CNAME` file. |
| 15 | + |
| 16 | +## Local development |
| 17 | + |
| 18 | +```bash |
| 19 | +python -m venv ./venv |
| 20 | +# Windows |
| 21 | +.\venv\Scripts\activate |
| 22 | +# macOS / Linux |
| 23 | +source venv/bin/activate |
| 24 | + |
| 25 | +pip install -r requirements.txt |
| 26 | +mkdocs serve # http://127.0.0.1:8000, live reload |
| 27 | +``` |
| 28 | + |
| 29 | +<details> |
| 30 | +<summary>Python on Windows</summary> |
| 31 | + |
| 32 | +Grab an installer from [python.org/downloads/windows](https://www.python.org/downloads/windows/) |
| 33 | +and make sure "Add python.exe to PATH" is ticked. If you used the embeddable build, pip |
| 34 | +comes from [get-pip.py](https://bootstrap.pypa.io/get-pip.py). |
| 35 | + |
| 36 | +</details> |
| 37 | + |
| 38 | +## Publishing |
| 39 | + |
| 40 | +```bash |
| 41 | +mkdocs gh-deploy --force |
| 42 | +``` |
| 43 | + |
| 44 | +Builds the site and force-pushes it to `gh-pages`; GitHub Pages serves it within a minute |
| 45 | +or so. Commit your Markdown changes to `docs` as well — `gh-deploy` only touches the built |
| 46 | +output. |
| 47 | + |
| 48 | +## Writing |
| 49 | + |
| 50 | +- One page per feature; the left-hand nav is defined explicitly in `mkdocs.yml`, so a new |
| 51 | + page needs an entry there to appear. |
| 52 | +- Node reference pages live under `docs/nodes/`, one per node type. |
| 53 | +- When the app's SDK surface changes, the matching page changes in the same sitting — the |
| 54 | + authoring guides here are the public contract for |
| 55 | + [`MODULES.md`](https://github.com/theprototype-app/core/blob/main/MODULES.md). |
| 56 | + |
| 57 | +## Related |
| 58 | + |
| 59 | +- [core](https://github.com/theprototype-app/core) — the app itself |
| 60 | +- [modules](https://github.com/theprototype-app/modules) — optional and community modules |
| 61 | +- [packs](https://github.com/theprototype-app/packs) — content packs |
0 commit comments