File tree Expand file tree Collapse file tree 1 file changed +29
-6
lines changed Expand file tree Collapse file tree 1 file changed +29
-6
lines changed Original file line number Diff line number Diff line change @@ -68,14 +68,37 @@ Subscribe to [gitStream Feature Announcements](https://github.com/linear-b/gitst
6868
6969## 📁 Local Documentation Server Setup
7070
71- To run the documentation server locally using Python (<=3.10, see ` .python-version ` ), follow these steps :
71+ This repository supports two documentation systems :
7272
73- 1 . Create a virtual environment named ` .venv ` using the command ` python -m venv .venv `
74- 2 . Activate the virtual environment by running the command ` . ./.venv/bin/activate `
75- 3 . Install the required packages by executing ` pip install -r requirements.txt `
76- 4 . Start the server by running ` mkdocs serve `
73+ ### MkDocs (Production/Default)
7774
78- The local documentation server should now be running at ` http://127.0.0.1:8000/ ` .
75+ The production documentation system, used by CI/CD. Requires Python 3.12 (or ≤3.10).
76+
77+ ``` bash
78+ # Create and activate virtual environment
79+ python3.12 -m venv .venv
80+ . .venv/bin/activate
81+
82+ # Install dependencies
83+ pip install -r requirements.txt
84+
85+ # Run server
86+ mkdocs serve # http://127.0.0.1:8000/
87+ ```
88+
89+ ### Zensical (Experimental)
90+
91+ An alternative documentation system being evaluated. Requires Python 3.11+.
92+
93+ ``` bash
94+ # Install dependencies (creates .venv-zensical automatically)
95+ UV_PROJECT_ENVIRONMENT=.venv-zensical uv sync
96+
97+ # Run server
98+ UV_PROJECT_ENVIRONMENT=.venv-zensical uv run zensical serve # http://127.0.0.1:8000/
99+ ```
100+
101+ ** Note:** Both servers use port 8000, so run only one at a time.
79102
80103# LinearB
81104
You can’t perform that action at this time.
0 commit comments