Decentralized Geospatial Hub

A collection of resources for the Decentralized Geospatial ecosystem.

All participating developers are highly encouraged to shape and evolve this space!

👋 Welcome

This repository brings together all the documentation resources within the Decentralized Geospatial organization to generate the Decentralized Geospatial Hub page.

🚢 How to contribute

Currently, most of the documentation in the docs folder is manually retrieved from their respective repositories and organized into the ecosystem folder. This is a temporary solution until we can automate the process of generating documentation from the repositories.

Please follow the contributing guidelines and documentation guidelines for more information on how to contribute overall to Decentralized Geospatial.

How to add a new project

1. Create a new folder in the docs/ecosystem/ directory with the name of your project.
2. Inside the new folder, create an index.md file that serves as the main entry point for your project documentation.
3. Add additional markdown files as needed to document your project.
4. Update the mkdocs.yml file in the root directory to include your new project in the navigation structure. This file defines the structure and layout of the documentation site.

View modifications locally

To view your modifications locally, you can use the mkdocs command-line tool. Follow these steps:

1. Install the python dependencies listed in pyproject.toml if you haven't already. You can do this using pip:

   pip install .

2. Run mkdocs build to build the documentation site. This will generate a static site in the site directory.

3. Run mkdocs server --clean --open to start a local server and open the documentation site in your default web browser. The --clean option removes and rebuilds when changes are made in the docs directory.

Publish the documentation

This respository is configured with github actions to automatically publish the documentation to GitHub Pages. Whenever you push changes to the main branch, the documentation will be built and deployed to the gh-pages branch.

Note: The gh-pages branch is a special branch used by GitHub Pages to serve static content. You don't need to manually push to this branch; the GitHub Actions workflow will handle it for you.

You can view the published documentation at https://decentralizedgeo.github.io/DecentralizedGeo-hub/.

🎓 License

All design work is licensed under the

MIT