diff --git a/docs/collector/collector-index.md b/docs/collector/collector-index.md index 00063eb..8730a4a 100644 --- a/docs/collector/collector-index.md +++ b/docs/collector/collector-index.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -title: πŸ‘©β€πŸ’» For Data Collectors +title: For Data Collectors --- # Data Collection with ODE @@ -25,9 +25,9 @@ If you're developing or extending ODE, see the [Developer Guide](/docs/developer Get up and running in 5 minutes: -1. **[Install Formulus](/docs/collector/install-formulus)** - Download and set up the app -2. **[Submit Your First Form](/docs/collector/first-submission)** - Get familiar with the interface -3. **[Sync Your Data](/docs/collector/syncing-data)** - Send data to the server +1. **[Install Formulus](/docs/getting-started/installing-formulus)** - Download and set up the app +2. **[Submit Your First Form](/docs/using/your-first-form)** - Get familiar with the interface +3. **[Sync Your Data](/docs/using/synchronization)** - Send data to the server ## What You'll Learn @@ -35,11 +35,11 @@ Get up and running in 5 minutes:
-

πŸ“² Getting Started

+

Getting Started

Install Formulus and set up your first project.

- Get Started β†’ + Get Started β†’
@@ -47,11 +47,11 @@ Get up and running in 5 minutes:
-

✏️ Using the App

+

Using the App

Learn form controls, data entry, and app features.

- Learn More β†’ + Learn More β†’
@@ -59,11 +59,11 @@ Get up and running in 5 minutes:
-

πŸ”„ Syncing Data

+

Syncing Data

Upload forms and sync with the server.

- Learn More β†’ + Learn More β†’
@@ -71,11 +71,11 @@ Get up and running in 5 minutes:
-

⚠️ Troubleshooting

+

Troubleshooting

Fix common issues and get help.

- Get Help β†’ + Get Help β†’
@@ -83,11 +83,11 @@ Get up and running in 5 minutes:
-

πŸ“‘ Offline Mode

+

Offline Mode

Understand how Formulus works without internet.

- Learn More β†’ + Learn More β†’
@@ -95,11 +95,11 @@ Get up and running in 5 minutes:
-

❓ FAQ

+

FAQ

Answers to common questions.

- Read FAQ β†’ + Read FAQ β†’
@@ -107,26 +107,26 @@ Get up and running in 5 minutes: ## Documentation Roadmap -### πŸ“š Learn the Basics -- [Installation & Setup](/docs/collector/install-formulus) -- [Your First Submission](/docs/collector/first-submission) -- [Basic Form Navigation](/docs/collector/using-the-app) - -### 🎯 Practical Tasks -- [Collecting Different Data Types](/docs/collector/using-the-app#data-types) -- [Managing Media (Photos, Audio)](/docs/collector/using-the-app#media-capture) -- [Working in Areas Without Internet](/docs/collector/working-offline) - -### πŸ”„ Data Management -- [Syncing Data to the Server](/docs/collector/syncing-data) -- [Understanding Sync Status](/docs/collector/syncing-data#sync-status) -- [Managing Local Storage](/docs/collector/data-management) - -### πŸ†˜ Troubleshooting -- [Sync Issues](/docs/collector/troubleshooting#sync-issues) -- [App Crashes or Freezes](/docs/collector/troubleshooting#app-issues) -- [Device Not Connecting](/docs/collector/troubleshooting#connection-issues) -- [Data Loss Prevention](/docs/collector/troubleshooting#data-loss) +### Learn the Basics +- [Installation & Setup](/docs/getting-started/installing-formulus) +- [Your First Submission](/docs/using/your-first-form) +- [Basic Form Navigation](/docs/using/formulus-features) + +### Practical Tasks +- [Collecting Different Data Types](/docs/using/formulus-features#form-field-types) +- [Managing Media (Photos, Audio)](/docs/using/formulus-features#form-field-types) +- [Working in Areas Without Internet](/docs/using/working-offline) + +### Data Management +- [Syncing Data to the Server](/docs/using/synchronization) +- [Understanding Sync Status](/docs/using/synchronization#sync-status) +- [Managing Local Storage](/docs/using/data-management) + +### Troubleshooting +- [Sync Issues](/docs/using/troubleshooting#synchronization-issues) +- [App Crashes or Freezes](/docs/using/troubleshooting#form-issues) +- [Device Not Connecting](/docs/using/troubleshooting#connection-issues) +- [Data Loss Prevention](/docs/using/troubleshooting#data-issues) ## Key Concepts diff --git a/docs/developer/developer-getting-started.md b/docs/developer/developer-getting-started.md index d1d18ef..189ca1b 100644 --- a/docs/developer/developer-getting-started.md +++ b/docs/developer/developer-getting-started.md @@ -279,7 +279,7 @@ Follow the detailed [Environment Setup](/docs/developer/setup-environment) guide 2. **Push to your fork** 3. **Create a pull request** with description 4. **Address feedback** from reviewers -5. **Celebrate!** πŸŽ‰ when merged +5. **Celebrate when merged** ## Code Quality Standards @@ -380,20 +380,20 @@ git commit -m "Add GPS field control for forms (Fixes #456)" ## Next Steps -### πŸš€ Ready to Code? +### Ready to Code? Choose your path and dive in: -1. **[Core Contributor Path](/docs/developer/setup-environment)** - Set up environment -2. **[Custom App Path](/docs/api/rest-api/overview)** - Learn the APIs -3. **[Deployment Path](/docs/implementer/deployment-guide)** - Deploy ODE -4. **[Integration Path](/docs/developer/extending-ode)** - Build integrations +1. **[Core Contributor Path](/docs/development/setup)** - Set up environment +2. **[Custom App Path](/docs/reference/rest-api/overview)** - Learn the APIs +3. **[Deployment Path](/docs/guides/deployment)** - Deploy ODE +4. **[Integration Path](/docs/development/extending)** - Build integrations -### πŸ“– Read More +### Read More -- [Architecture Overview](/docs/developer/architecture) -- [Component Development](/docs/developer/components) -- [Contributing Guide](/docs/developer/contributing-guide) +- [Architecture Overview](/docs/development/architecture) +- [Component Development](/docs/reference/components) +- [Contributing Guide](/docs/development/contributing) - [Community Support](/docs/community/getting-help) --- diff --git a/docs/development/installation.md b/docs/development/installation.md index 2cf68bc..8f3ec62 100644 --- a/docs/development/installation.md +++ b/docs/development/installation.md @@ -317,14 +317,14 @@ Verify the installation: Formulus is the mobile application component of ODE, available for Android and iOS devices. -For detailed installation instructions, see the [Installing Formulus guide](/getting-started/installing-formulus) which covers: +For detailed installation instructions, see the [Installing Formulus guide](/docs/getting-started/installing-formulus) which covers: - F-Droid installation (recommended for end users) - Direct APK installation - System requirements - Post-installation setup -For developers who want to install via ADB or emulator, see the [Development Installation guide](/development/installing-formulus-dev). +For developers who want to install via ADB or emulator, see the [Development Installation guide](/docs/development/installing-formulus-dev). ### Quick Installation Summary @@ -333,7 +333,7 @@ For developers who want to install via ADB or emulator, see the [Development Ins 1. **F-Droid** (Recommended): Install via F-Droid app store 2. **Direct APK**: Download and install APK file directly -See [Installing Formulus](/getting-started/installing-formulus) for complete instructions. +See [Installing Formulus](/docs/getting-started/installing-formulus) for complete instructions. #### For Developers @@ -341,7 +341,7 @@ See [Installing Formulus](/getting-started/installing-formulus) for complete ins 2. **Emulator**: Run on Android emulator 3. **Development Build**: Build from source with hot reload -See [Installing Formulus for Development](/development/installing-formulus-dev) for complete instructions. +See [Installing Formulus for Development](/docs/development/installing-formulus-dev) for complete instructions. ### App Configuration @@ -420,7 +420,7 @@ If the mobile app cannot connect to the server: ## Next Steps -- Follow the [Quick Start guide](/getting-started/quick-start) for a complete setup -- Learn how to [use the app](/using/your-first-form) for data collection -- Review the [Deployment guide](/guides/deployment) for production setup +- Follow the [Quick Start guide](/docs/getting-started/index) for a complete setup +- Learn how to [use the app](/docs/using/your-first-form) for data collection +- Review the [Deployment guide](/docs/guides/deployment) for production setup diff --git a/docs/development/installing-formulus-dev.md b/docs/development/installing-formulus-dev.md index 0156b8e..2314ee6 100644 --- a/docs/development/installing-formulus-dev.md +++ b/docs/development/installing-formulus-dev.md @@ -504,7 +504,7 @@ Windows typically handles USB device permissions automatically. If you encounter ## Related Documentation -- [Formulus Development Setup](/development/formulus-development) - Complete development environment setup -- [Formulus Component Reference](/reference/formulus) - Detailed component documentation -- [Building and Testing](/development/building-testing) - Build and test procedures +- [Formulus Development Setup](/docs/development/formulus-development) - Complete development environment setup +- [Formulus Component Reference](/docs/reference/formulus) - Detailed component documentation +- [Building and Testing](/docs/development/building-testing) - Build and test procedures diff --git a/docs/getting-started/installing-formulus.md b/docs/getting-started/installing-formulus.md index d016cf9..ab0f7bd 100644 --- a/docs/getting-started/installing-formulus.md +++ b/docs/getting-started/installing-formulus.md @@ -159,7 +159,7 @@ If Obtainium is not available or you prefer direct installation: ### Method 3: Development Build -For developers who want to build and install from source, see the [Development Installation Guide](development/formulus-development). +For developers who want to build and install from source, see the [Development Installation Guide](/docs/development/formulus-development). ## Post-Installation Setup @@ -300,8 +300,8 @@ After installation, you can find and launch Formulus: ## Related Documentation -- [Formulus Features](using/formulus-features) - Learn about app features and usage -- [Your First Form](using/your-first-form) - Get started with data collection -- [Synchronization](using/synchronization) - Understand how data syncs work -- [Development Installation](development/formulus-development) - For developers building from source +- [Formulus Features](/docs/using/formulus-features) - Learn about app features and usage +- [Your First Form](/docs/using/your-first-form) - Get started with data collection +- [Synchronization](/docs/using/synchronization) - Understand how data syncs work +- [Development Installation](/docs/development/formulus-development) - For developers building from source diff --git a/docs/implementer/implementer-index.md b/docs/implementer/implementer-index.md index 18e2849..77373a0 100644 --- a/docs/implementer/implementer-index.md +++ b/docs/implementer/implementer-index.md @@ -26,9 +26,9 @@ If you're developing or extending ODE, see the [Developer Guide](/docs/developer Get your first form running in 30 minutes: -1. **[Understand the Basics](/docs/implementer/overview)** - Learn how forms and projects work -2. **[Design Your First Form](/docs/implementer/form-design-guide)** - Create a form using JSON schema -3. **[Deploy Your Form](/docs/implementer/deployment-guide)** - Get it to field workers +1. **[Understand the Basics](/docs/implementer/implementer-overview)** - Learn how forms and projects work +2. **[Design Your First Form](/docs/guides/form-design)** - Create a form using JSON schema +3. **[Deploy Your Form](/docs/guides/deployment)** - Get it to field workers ## What You'll Learn @@ -36,11 +36,11 @@ Get your first form running in 30 minutes:
-

🎯 Implementer Overview

+

Implementer Overview

Understand your role and project planning basics.

- Get Started β†’ + Get Started β†’
@@ -48,11 +48,11 @@ Get your first form running in 30 minutes:
-

πŸ“ Form Design Guide

+

Form Design Guide

Master JSON schema and UI design patterns.

- Learn More β†’ + Learn More β†’
@@ -60,11 +60,11 @@ Get your first form running in 30 minutes:
-

πŸ”§ JSON Forms Reference

+

JSON Forms Reference

Complete reference for form controls and validation.

- Reference β†’ + Reference β†’
@@ -72,11 +72,11 @@ Get your first form running in 30 minutes:
-

πŸš€ Deployment Guide

+

Deployment Guide

Steps to deploy forms to field teams.

- Deploy β†’ + Deploy β†’
@@ -84,11 +84,11 @@ Get your first form running in 30 minutes:
-

πŸ“Š Data Management

+

Data Management

Collect, review, and export data securely.

- Learn More β†’ + Learn More β†’
@@ -96,11 +96,11 @@ Get your first form running in 30 minutes:
-

⚠️ Troubleshooting

+

Troubleshooting

Fix issues with forms, sync, or deployment.

- Get Help β†’ + Get Help β†’
@@ -109,34 +109,34 @@ Get your first form running in 30 minutes: ## Documentation Roadmap ### πŸŽ“ Learn the Concepts -- [Implementer Role Overview](/docs/implementer/overview) -- [How ODE Works](/docs/implementer/overview#how-ode-works) -- [Project Planning Checklist](/docs/implementer/overview#project-planning) - -### πŸ“‹ Design Forms -- [Form Design Principles](/docs/implementer/form-design-guide) -- [JSON Schema Basics](/docs/implementer/form-design-guide#json-schema) -- [UI Schema for User Experience](/docs/implementer/form-design-guide#ui-schema) -- [Form Controls Reference](/docs/implementer/json-forms-reference) -- [Validation Rules](/docs/implementer/form-design-guide#validation) - -### 🎨 Advanced Form Features -- [Conditional Fields](/docs/implementer/form-design-guide#conditional-logic) -- [Dynamic Choice Lists](/docs/implementer/form-design-guide#dynamic-choices) -- [Media Capture (Photos, Audio)](/docs/implementer/form-design-guide#media) -- [Calculated Fields](/docs/implementer/form-design-guide#calculations) - -### πŸš€ Deployment & Operations -- [Deployment Planning](/docs/implementer/deployment-guide) -- [Creating App Bundles](/docs/implementer/app-bundles) -- [User Management](/docs/implementer/deployment-guide#user-management) -- [Monitoring Form Submissions](/docs/implementer/data-management#monitoring) - -### πŸ“Š Data Management -- [Understanding Data Structure](/docs/implementer/data-management) -- [Exporting Data](/docs/implementer/data-management#export) -- [Data Quality & Validation](/docs/implementer/data-management#quality) -- [Archiving Old Data](/docs/implementer/data-management#archiving) +- [Implementer Role Overview](/docs/implementer/implementer-overview) +- [How ODE Works](/docs/implementer/implementer-overview#how-ode-works) +- [Project Planning Checklist](/docs/implementer/implementer-overview#project-planning) + +### Design Forms +- [Form Design Principles](/docs/guides/form-design) +- [JSON Schema Basics](/docs/guides/form-design#json-schema) +- [UI Schema for User Experience](/docs/guides/form-design#ui-schema) +- [Form Controls Reference](/docs/reference/formplayer) +- [Validation Rules](/docs/guides/form-design#validation) + +### Advanced Form Features +- [Conditional Fields](/docs/guides/form-design#conditional-logic) +- [Dynamic Choice Lists](/docs/guides/form-design#dynamic-choices) +- [Media Capture (Photos, Audio)](/docs/guides/form-design#media) +- [Calculated Fields](/docs/guides/form-design#calculations) + +### Deployment & Operations +- [Deployment Planning](/docs/guides/deployment) +- [Creating App Bundles](/docs/using/app-bundles) +- [User Management](/docs/guides/deployment#user-management) +- [Monitoring Form Submissions](/docs/using/data-management#monitoring) + +### Data Management +- [Understanding Data Structure](/docs/using/data-management) +- [Exporting Data](/docs/using/data-management#export) +- [Data Quality & Validation](/docs/using/data-management#quality) +- [Archiving Old Data](/docs/using/data-management#archiving) ### πŸ”§ Configuration - [Server Configuration](/docs/api/configuration/server) @@ -190,22 +190,22 @@ As an Implementer, you typically: ### Scenario 1: Health Survey You're conducting a community health survey with 50 field workers across a region with limited connectivity. -β†’ [See the Health Survey Template Guide](/docs/implementer/form-design-guide#health-survey-example) +β†’ [See the Health Survey Template Guide](/docs/guides/form-design#health-survey-example) ### Scenario 2: Multi-Form Campaign You're managing a 3-form workflow where later forms depend on earlier responses. -β†’ [See Forms with Conditional Logic](/docs/implementer/form-design-guide#conditional-logic) +β†’ [See Forms with Conditional Logic](/docs/guides/form-design#conditional-logic) ### Scenario 3: Offline Deployment You need workers to collect data with zero internet connectivity for extended periods. -β†’ [See Offline Deployment Guide](/docs/implementer/deployment-guide#offline) +β†’ [See Offline Deployment Guide](/docs/guides/deployment#offline) ### Scenario 4: Large-Scale Rollout You're deploying to 1000+ workers across multiple countries. -β†’ [See Scaling & Infrastructure](/docs/implementer/deployment-guide#scale) +β†’ [See Scaling & Infrastructure](/docs/guides/deployment#scale) ## Terminology @@ -235,9 +235,9 @@ You should have: If you need assistance: -1. **Check the form design guide** β†’ [Form Design Guide](/docs/implementer/form-design-guide) -2. **Look up a control type** β†’ [JSON Forms Reference](/docs/implementer/json-forms-reference) -3. **Review deployment steps** β†’ [Deployment Guide](/docs/implementer/deployment-guide) +1. **Check the form design guide** β†’ [Form Design Guide](/docs/guides/form-design) +2. **Look up a control type** β†’ [Form Controls Reference](/docs/reference/formplayer) +3. **Review deployment steps** β†’ [Deployment Guide](/docs/guides/deployment) 4. **Contact the community** β†’ [Get Help](/docs/community/getting-help) 5. **Report an issue** β†’ [GitHub Issues](https://github.com/OpenDataEnsemble/ode) @@ -245,11 +245,11 @@ If you need assistance: Ready to start designing? Let's begin! -β†’ **[Implementer Overview](/docs/implementer/overview)** +β†’ **[Implementer Overview](/docs/implementer/implementer-overview)** Or jump straight to form design: -β†’ **[Form Design Guide](/docs/implementer/form-design-guide)** +β†’ **[Form Design Guide](/docs/guides/form-design)** --- diff --git a/docs/implementer/implementer-overview.md b/docs/implementer/implementer-overview.md index 4a559a4..db2eb95 100644 --- a/docs/implementer/implementer-overview.md +++ b/docs/implementer/implementer-overview.md @@ -363,9 +363,9 @@ For large-scale projects (1000+ users): ### πŸ‘‰ Start Here 1. **Understand your project needs** - What data do you need? -2. **Learn form design** β†’ [Form Design Guide](/docs/implementer/form-design-guide) -3. **Design your first form** β†’ [JSON Forms Reference](/docs/implementer/json-forms-reference) -4. **Plan deployment** β†’ [Deployment Guide](/docs/implementer/deployment-guide) +2. **Learn form design** β†’ [Form Design Guide](/docs/guides/form-design) +3. **Design your first form** β†’ [Form Controls Reference](/docs/reference/formplayer) +4. **Plan deployment** β†’ [Deployment Guide](/docs/guides/deployment) ### πŸ“š Resources @@ -376,10 +376,10 @@ For large-scale projects (1000+ users): ## Getting Help -- **Questions about form design?** β†’ [Form Design Guide](/docs/implementer/form-design-guide) -- **What controls can I use?** β†’ [JSON Forms Reference](/docs/implementer/json-forms-reference) -- **How do I deploy?** β†’ [Deployment Guide](/docs/implementer/deployment-guide) -- **Help with specific issues?** β†’ [Troubleshooting](/docs/implementer/troubleshooting) +- **Questions about form design?** β†’ [Form Design Guide](/docs/guides/form-design) +- **What controls can I use?** β†’ [Form Controls Reference](/docs/reference/formplayer) +- **How do I deploy?** β†’ [Deployment Guide](/docs/guides/deployment) +- **Help with specific issues?** β†’ [Troubleshooting](/docs/using/troubleshooting) - **Need community support?** β†’ [Get Help](/docs/community/getting-help) --- @@ -388,5 +388,5 @@ For large-scale projects (1000+ users): Let's create a simple form to collect basic information about health clinics. -β†’ **[Form Design Guide](/docs/implementer/form-design-guide)** +β†’ **[Form Design Guide](/docs/guides/form-design)** ::: diff --git a/docs/index.md b/docs/index.md index 324605f..682f332 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,7 +14,7 @@ Open Data Ensemble (ODE) is a comprehensive platform for mobile data collection The source code for the pre-release version of ODE is now publicly available. While we're working toward the full 1.0 release, we welcome anyone willing to help with testing, development, or getting involved in the project. -**Try the pre-release:** [Install Formulus on Android](/getting-started/installation) +**Try the pre-release:** [Install Formulus on Android](/docs/getting-started/installing-formulus) **Get involved:** Reach out to us at [hello@opendataensemble.org](mailto:hello@opendataensemble.org) - we'd love to hear from you! @@ -22,6 +22,29 @@ The source code for the pre-release version of ODE is now publicly available. Wh ::: +## The Problem ODE Solves + +Traditional data collection tools often have limitations: + +- **No offline support** - Without internet, collection stops +- **Complexity** - Building forms requires technical expertise +- **Inflexibility** - Customization is difficult and expensive +- **Lock-in** - Data is trapped in proprietary systems +- **Cost** - Enterprise solutions are prohibitively expensive + +## How ODE Works + +ODE provides an integrated system for the complete data lifecycle: + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Collect β”‚ ──► β”‚ Sync β”‚ ──► β”‚ Analyze β”‚ +β”‚ Data β”‚ β”‚ Offline β”‚ β”‚ & Export β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + Formulus WatermelonDB + Parquet Export + (App) Synkronus (Server) (Your Tools) +``` + ## What is ODE? ODE is a modern toolkit that simplifies mobile data collection through: @@ -72,9 +95,9 @@ Build custom applications that integrate with the ODE platform, allowing for spe ## Getting Started -New to ODE? Start with our [Getting Started guide](/getting-started/what-is-ode) to understand the platform and begin your first project. +New to ODE? Start with our [Getting Started guide](/docs/getting-started/why-ode) to understand the platform and begin your first project. -For developers looking to contribute or extend ODE, see the [Development section](/development/setup) for architecture details and contribution guidelines. +For developers looking to contribute or extend ODE, see the [Development section](/docs/development/setup) for architecture details and contribution guidelines. ## Documentation Structure @@ -89,7 +112,7 @@ This documentation is organized to help you find information quickly: ## Next Steps -- Read [What is ODE?](/getting-started/what-is-ode) for a detailed overview -- Follow the [Installation guide](/getting-started/installation) to set up your environment -- Create your [first form](/using/your-first-form) to see ODE in action -- Explore the [API Reference](/reference/api) for technical details +- Read [Why ODE?](/docs/getting-started/why-ode) for a detailed overview +- Follow the [Installation guide](/docs/getting-started/installing-formulus) to set up your environment +- Create your [first form](/docs/using/your-first-form) to see ODE in action +- Explore the [API Reference](/docs/reference/api) for technical details diff --git a/docs/reference/app-bundle-format.md b/docs/reference/app-bundle-format.md index 0fc6fa4..06b4f3a 100644 --- a/docs/reference/app-bundle-format.md +++ b/docs/reference/app-bundle-format.md @@ -210,6 +210,6 @@ Mobile devices download app bundles during synchronization: ## Related Documentation -- [Custom Applications Guide](/guides/custom-applications) -- [API Reference](/reference/api) -- [Form Design Guide](/guides/form-design) +- [Custom Applications Guide](/docs/guides/custom-applications) +- [API Reference](/docs/reference/api) +- [Form Design Guide](/docs/guides/form-design) diff --git a/docs/reference/rest-api/app-bundle.md b/docs/reference/rest-api/app-bundle.md index 3200920..c213275 100644 --- a/docs/reference/rest-api/app-bundle.md +++ b/docs/reference/rest-api/app-bundle.md @@ -21,5 +21,5 @@ API endpoints for managing app bundles. ## Related Content - [REST API Overview](/docs/reference/rest-api/overview) -- [App Bundle Structure](/reference/app-bundle-format) +- [App Bundle Structure](/docs/reference/app-bundle-format) diff --git a/docs/reference/rest-api/attachments.md b/docs/reference/rest-api/attachments.md index 4ec8e95..08843cb 100644 --- a/docs/reference/rest-api/attachments.md +++ b/docs/reference/rest-api/attachments.md @@ -21,5 +21,5 @@ API endpoints for managing file attachments. ## Related Content - [REST API Overview](/docs/reference/rest-api/overview) -- [Data Management](/using/data-management) +- [Data Management](/docs/using/data-management) diff --git a/docs/reference/rest-api/authentication.md b/docs/reference/rest-api/authentication.md index 993e2e9..17bff3a 100644 --- a/docs/reference/rest-api/authentication.md +++ b/docs/reference/rest-api/authentication.md @@ -21,5 +21,5 @@ API endpoints for authentication. ## Related Content - [REST API Overview](/docs/reference/rest-api/overview) -- [Users & Authentication](/reference/api) +- [Users & Authentication](/docs/reference/api) diff --git a/docs/reference/rest-api/overview.md b/docs/reference/rest-api/overview.md index 74d8dc5..f94c6ba 100644 --- a/docs/reference/rest-api/overview.md +++ b/docs/reference/rest-api/overview.md @@ -27,6 +27,6 @@ Complete REST API reference for Synkronus. ## Related Content -- [OpenAPI Specification](/api) -- [Synkronus API Reference](/reference/api) +- [OpenAPI Specification](/docs/reference/api) +- [Synkronus API Reference](/docs/reference/api) diff --git a/docs/reference/rest-api/sync.md b/docs/reference/rest-api/sync.md index 82275b4..281fc74 100644 --- a/docs/reference/rest-api/sync.md +++ b/docs/reference/rest-api/sync.md @@ -21,5 +21,5 @@ API endpoints for data synchronization. ## Related Content - [REST API Overview](/docs/reference/rest-api/overview) -- [Synchronization Protocol](/using/synchronization) +- [Synchronization Protocol](/docs/using/synchronization) diff --git a/docs/reference/synkronus-cli.md b/docs/reference/synkronus-cli.md index c7c6d7a..aa73693 100644 --- a/docs/reference/synkronus-cli.md +++ b/docs/reference/synkronus-cli.md @@ -469,8 +469,8 @@ synk --verbose ## Related Documentation -- [Synkronus Server Reference](/reference/synkronus-server) - Server API documentation -- [App Bundle Format](/reference/app-bundle-format) - Bundle structure -- [API Reference](/reference/api) - Complete API documentation -- [Deployment Guide](/guides/deployment) - Server deployment +- [Synkronus Server Reference](/docs/reference/synkronus-server) - Server API documentation +- [App Bundle Format](/docs/reference/app-bundle-format) - Bundle structure +- [API Reference](/docs/reference/api) - Complete API documentation +- [Deployment Guide](/docs/guides/deployment) - Server deployment diff --git a/docs/welcome/what-is-ode.md b/docs/welcome/what-is-ode.md deleted file mode 100644 index 57a59a1..0000000 --- a/docs/welcome/what-is-ode.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: What is ODE? ---- - -# What is Open Data Ensemble? - -Open Data Ensemble (ODE) is a comprehensive, open-source platform for mobile data collection and synchronization. Built for researchers, health professionals, implementers, and developers, ODE provides a robust solution for designing forms, collecting data securely, and synchronizing seamlessly across devicesβ€”even in offline conditions. - -:::tip Pronunciation -ODE is pronounced like "code", without the "C." -::: - -## The Problem ODE Solves - -Traditional data collection tools often have limitations: - -- **No offline support** - Without internet, collection stops -- **Complexity** - Building forms requires technical expertise -- **Inflexibility** - Customization is difficult and expensive -- **Lock-in** - Data is trapped in proprietary systems -- **Cost** - Enterprise solutions are prohibitively expensive - -## How ODE Works - -ODE provides an integrated system for the complete data lifecycle: - -``` -β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” -β”‚ Collect β”‚ ──► β”‚ Sync β”‚ ──► β”‚ Analyze β”‚ -β”‚ Data β”‚ β”‚ Offline β”‚ β”‚ & Export β”‚ -β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ - Formulus WatermelonDB + Parquet Export - (App) Synkronus (Server) (Your Tools) -``` - -### Key Features - -- **πŸ“± Mobile-First Design** - Optimized for Android and iOS -- **πŸ”Œ Works Offline** - Full functionality without internet; automatic sync when online -- **🎨 Easy Form Creation** - JSON-based form design, no coding required -- **πŸ” Secure & Encrypted** - Data is encrypted at rest and in transit -- **♻️ Open Source** - Fully transparent, auditable, and extensible -- **πŸ“Š Flexible Data Export** - Export to Parquet, JSON, or custom formats -- **⚑ Performant** - Minimal battery and data consumption - -## The ODE Ensemble - -ODE consists of four main components that work together: - -| Component | Role | Technology | -|-----------|------|-----------| -| **Formulus** | Mobile app for data collection | React Native (Android/iOS) | -| **Synkronus** | Server managing sync & storage | Go + PostgreSQL | -| **Formplayer** | Form rendering engine | React | -| **Synkronus CLI** | Server administration tool | Go CLI | - -## Who Uses ODE? - -### πŸ‘©β€πŸ’» **Data Collectors** -Field workers, researchers, and community health workers collecting data on mobile devices. - -β†’ **[Start here if you're collecting data](/docs/collector)** - -### πŸ“‹ **Implementers** -Form designers, project managers, and NGO leaders designing and deploying forms. - -β†’ **[Start here if you're designing forms](/docs/implementer)** - -### βš™οΈ **Developers** -Engineers building, extending, or contributing to ODE. - -β†’ **[Start here if you're developing](/docs/developer)** - -## Why Choose ODE? - -### For Organizations -- **Cost-Effective** - No licensing fees; run on your own infrastructure -- **Customizable** - Adapt forms and workflows to your needs -- **Reliable** - Designed for challenging environments (poor connectivity, limited power) -- **Transparent** - Audit the code, understand what's happening with your data -- **Sustainable** - Community-driven development, long-term support - -### For Developers -- **Modern Stack** - React Native, React, Goβ€”industry-standard technologies -- **Well-Documented** - Clear guides and API documentation -- **Extensible** - Build custom integrations and applications -- **Community** - Active development team and growing contributor community -- **Educational** - Learn mobile development, synchronization patterns, offline-first architecture - -### For Data -- **Open Format** - Data isn't locked in proprietary systems -- **Export Options** - Multiple formats (Parquet, JSON, CSV via export tools) -- **Compliance** - Built with privacy and security in mind -- **Ownership** - You control your data, your server, your infrastructure - -## Quick Links - -- **First time here?** β†’ Start with [Getting Started](/docs/welcome) -- **Using Formulus?** β†’ Go to [Data Collector Guide](/docs/collector) -- **Designing forms?** β†’ Go to [Implementer Guide](/docs/implementer) -- **Contributing to ODE?** β†’ Go to [Developer Guide](/docs/developer) -- **Need help?** β†’ See [Community & Support](/docs/community/getting-help) - -## Architecture Overview - -At a high level, ODE uses a **client-server architecture** optimized for offline-first data collection: - -``` - Internet Connection - β”‚ - β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” - β”‚ β”‚ β”‚ - β–Ό β–Ό β–Ό - β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” - β”‚ Formulusβ”‚ β”‚Formulus β”‚ β”‚Synkronus β”‚ - β”‚ (Device 1) β”‚(Device 2) β”‚(Server) β”‚ - β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ - β”‚ β”‚ β”‚ - β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ - Sync Protocol (offline-capable) - - Local Storage: WatermelonDB (offline-first) - Server Storage: PostgreSQL - Rendering Engine: Formplayer (React WebView) -``` - -- **Each device** stores data locally and works offline -- **Automatic sync** when connection is available -- **Conflict resolution** ensures data consistency -- **Server** provides single source of truth for data - -## Ready to Get Started? - -Choose your path based on your role: - -### πŸ‘©β€πŸ’» I'm collecting data with Formulus -β†’ [Collector Quick Start](/docs/collector/getting-started) - -### πŸ“‹ I'm designing forms and managing projects -β†’ [Implementer Quick Start](/docs/implementer/overview) - -### βš™οΈ I'm developing or contributing to ODE -β†’ [Developer Quick Start](/docs/developer/getting-started) - -### ❓ I just want to learn more -β†’ Continue reading [Why ODE?](/docs/welcome/why-ode) or [Key Concepts](/docs/welcome/key-concepts) - ---- - -**Questions?** [Get help from the community](/docs/community/getting-help) diff --git a/sidebars.ts b/sidebars.ts index b402c30..1cc53a9 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -23,20 +23,16 @@ const sidebars: SidebarsConfig = { label: 'Welcome to ODE', }, - // Welcome & Getting Started (for all users) + // Getting Started { type: 'category', - label: 'Welcome', - link: { - type: 'doc', - id: 'welcome/what-is-ode', - }, + label: 'Getting Started', items: [ - 'welcome/what-is-ode', 'getting-started/why-ode', 'getting-started/key-concepts', 'getting-started/faq', 'getting-started/architecture-overview', + 'getting-started/installing-formulus', ], },