# 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](https://niamoto.github.io/niamoto/). This page is
the same portal inside the repository.

## Start here

- [01-getting-started/README.md](01-getting-started/README.md) — install
  the desktop app, open your first project, understand the core
  concepts.
- [02-user-guide/README.md](02-user-guide/README.md) — the day-to-day
  desktop workflow: import, collections, site, publish.
- [03-cli-automation/README.md](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](01-getting-started/README.md), then
  [02-user-guide](02-user-guide/README.md).
- **Write a plugin** — see
  [04-plugin-development](04-plugin-development/README.md) and the
  [reference](06-reference/README.md).
- **Understand how the ML auto-detection works** — see
  [05-ml-detection](05-ml-detection/README.md).
- **Look at the architecture** — see
  [07-architecture](07-architecture/README.md). 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](08-roadmaps/README.md) for the slim public landing page.

## Structure

### User guide
- [01-getting-started/](01-getting-started/README.md)
- [02-user-guide/](02-user-guide/README.md)

### Advanced
- [03-cli-automation/](03-cli-automation/README.md)
- [04-plugin-development/](04-plugin-development/README.md)
- [05-ml-detection/](05-ml-detection/README.md)

### Reference
- [06-reference/](06-reference/README.md)
- [06-reference/api/modules.rst](06-reference/api/modules.rst) —
  autogenerated Python API

### Project
- [07-architecture/](07-architecture/README.md)
- [08-roadmaps/](08-roadmaps/README.md) — now a lightweight landing page
- [09-troubleshooting/](09-troubleshooting/README.md)

### Internal (not rendered in the live site)
- `docs/plans/` — dated feature plans
- `docs/brainstorms/` — exploratory sessions
- `docs/ideation/` — open idea notes
- `docs/_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.

## Related

- Project root: `README.md`
- Changelog: `CHANGELOG.md`
- License: `LICENSE`