Product documentation of GI projects - published as a site at roadmap.gi.org.pl.
| Folder | Description |
|---|---|
| myPolitics | Docs, specs, roadmap and tasks of myPolitics |
| Asystent NGO | Developer tasks of Asystent NGO |
The markdown files are the source of truth. The site is generated from them on every merge to main - nothing is written for the site separately.
- What is published - everything under mypolitics except
tasks/. - Navigation follows the folders - each folder is a section and its
README.mdis the section's landing page. A new file appears on the site by itself. - Titles come from the first heading - the
# Titleof a file is its name in the navigation. - Links stay relative - link to other files as
./file.md, the same way that works on GitHub. Images go tomypolitics/assets/.
- Change or add a markdown file under
mypolitics/. - Open a pull request - the site is built as a check, so a file that breaks the build is caught there.
- Merge to
main- the site is rebuilt and published within a minute or two.
pip install -r requirements.txt
mkdocs serve
The site is then served at http://127.0.0.1:8000 and reloads on every save. Links to files that do not exist are listed as warnings in the terminal.
| File | Description |
|---|---|
| mkdocs.yml | Site configuration - MkDocs with the Material theme |
| site-hooks.py | Sends links to folders left out of the site to GitHub |
| requirements.txt | Pinned versions of the build tools |
| docs.yml | Builds on pull requests, publishes to GitHub Pages on main |