Docs

Overview

Mergin Maps offers a comprehensive documentation system designed to streamline the deployment and management of geospatial data applications. With a focus on both staging and production environments, Mergin Maps provides clear guidelines and tools for developers to effectively manage their code and documentation. This system is particularly valuable for teams looking to maintain high standards in project documentation and ensures smooth development workflows.

Features

• Deployment Management: Easily deploy updates to both staging and production environments with simple commands and checks in place.
• GitHub Integration: Utilize GitHub Pull Requests to propose, review, and merge changes seamlessly, ensuring efficient collaboration among team members.
• Local Development Support: Run a local server for developing and previewing documentation at http://localhost:8080/, allowing real-time edits.
• Docker Compatibility: Spin up a node Docker container using the provided compose file for a consistent development environment.
• Static Site Generation: Generate static HTML files for documentation effortlessly, with results available in the dist folder for easy access.
• Documentation Guidelines: Follow clear guidelines for modifying content and ensuring compliance with Mergin Maps standards.
• Licensing Clarity: Documentation and code are clearly licensed under CC-BY and MIT licenses, ensuring transparency for users.
• Future Translation Support: While translations are not currently supported, updates are planned as documented in the project’s GitHub issues.