Riviamigo documentation
Riviamigo's repository documentation is the source of truth for the application, its operation, and its implementation. This site is built directly from docs/ whenever a relevant change reaches main.
Choose your path
| If you want to... | Start here |
|---|---|
| Understand the project, privacy model, security posture, or roadmap | Overview — continue through this section |
| Prepare, install, connect, and verify a new installation | Getting Started |
| Customize dashboards or control optional external services | Using Riviamigo |
| Update, secure, back up, recover, or troubleshoot an installation | Operations |
| Understand architecture or contribute code and documentation | Development |
| Look up APIs, metrics, or dashboard data contracts | Reference |
Common tasks
| Need | Start here |
|---|---|
| See what Riviamigo currently supports | Features |
| Understand privacy and external requests | Privacy |
| Review deployment security | Security |
| Customize an installed dashboard | Using Riviamigo |
| Update or recover an installation | Operations |
| Understand the repository structure | Architecture overview |
| Build or change dashboards | Dashboard architecture |
| Look up APIs, metrics, or dashboard data | Reference |
Canonical entry points
README.mdintroduces the project and provides the shortest installation summary.AGENTS.mddefines repository policy for Codex and other repo-aware agents.CLAUDE.mdprovides companion command and execution guidance.docs/branding.mddefines the shared visual system.- This documentation site renders the complete
docs/tree for easy navigation and review.
If behavior, structure, operations, or shared visual language changes, update its canonical document in the same pull request or create explicit tracked documentation debt.