Niamoto Documentation¶
Status: Active Audience: Anyone reading the Niamoto docs in-repo or on GitHub Pages. Purpose: Portal to the full documentation tree.
The rendered version lives at niamoto.github.io/niamoto. This page is the same portal inside the repository.
Start here¶
01-getting-started/README.md — install the desktop app, open your first project, understand the core concepts.
02-user-guide/README.md — the day-to-day desktop workflow: import, collections, site, publish.
03-cli-automation/README.md — drive the pipeline from the shell, GitHub Actions, or your own scripts.
If you want to…¶
Create a biodiversity portal from your CSVs — start with 01-getting-started, then 02-user-guide.
Write a plugin — see 04-plugin-development and the reference.
Understand how the ML auto-detection works — see 05-ml-detection.
Look at the architecture — see 07-architecture. The ADRs under
docs/07-architecture/adr/are background notes, not required reading.Track planning work — see the dated plan files in
docs/plans/first, then 08-roadmaps for the slim public landing page.
Structure¶
User guide¶
Advanced¶
Reference¶
06-reference/api/modules.rst — autogenerated Python API
Project¶
08-roadmaps/ — now a lightweight landing page
Internal (not rendered in the live site)¶
docs/plans/— dated feature plansdocs/brainstorms/— exploratory sessionsdocs/ideation/— open idea notesdocs/_archive/— historical pages kept for reference
Style and contributions¶
docs/STYLE_GUIDE.md— voice, banned vocabulary, preferred verbs.CONTRIBUTING.md— development setup, PR workflow, documentation rules.