Skip to main content

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 roadmapOverview — continue through this section
Prepare, install, connect, and verify a new installationGetting Started
Customize dashboards or control optional external servicesUsing Riviamigo
Update, secure, back up, recover, or troubleshoot an installationOperations
Understand architecture or contribute code and documentationDevelopment
Look up APIs, metrics, or dashboard data contractsReference

Common tasks

NeedStart here
See what Riviamigo currently supportsFeatures
Understand privacy and external requestsPrivacy
Review deployment securitySecurity
Customize an installed dashboardUsing Riviamigo
Update or recover an installationOperations
Understand the repository structureArchitecture overview
Build or change dashboardsDashboard architecture
Look up APIs, metrics, or dashboard dataReference

Canonical entry points

  • README.md introduces the project and provides the shortest installation summary.
  • AGENTS.md defines repository policy for Codex and other repo-aware agents.
  • CLAUDE.md provides companion command and execution guidance.
  • docs/branding.md defines 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.