Contributing

Thanks for your interest in VersaTiles! This repository hosts the documentation and the Showcases gallery. Code for the various components lives in other repositories under versatiles-org.

The contributions most useful to us, in order:

Add your project to Showcases

If you use VersaTiles in a public project, we'd love to feature it.

1. Open showcases/showcases.yaml and append a new entry:

   - title: 'Your Project'
     url: 'https://example.org'
     source: 'Your Org'
     country: 'Germany'
     category: 'commercial' # or: journalism,independent, research, events
     description: 'One sentence about what the project shows'
     thumbnail: your-project-slug
     tags:
       - interactive-map
       # - any other tags already used by other entries

2. Drop a screenshot at showcases/your-project-slug.png (PNG, 16:9, < 1 MB, it's auto-resized to 800×450 during build).

3. Open a pull request.

That's it — no code changes needed.

Fix or improve the docs

• Typos and small fixes: the easiest path is the "Edit this page on GitHub" link in the footer of every page on docs.versatiles.org. It opens GitHub's web editor scoped to the right file.
• Larger changes: clone the repo and preview locally before opening a PR:

  npm install
  npm run dev

  This starts the VitePress dev server with hot reload at http://localhost:5173.

Report a bug or request a feature

• Issues with documentation content — open an issue in this repository.
• Issues with VersaTiles itself — pick the right component repository under github.com/versatiles-org. The most active ones:
  • versatiles-rs — Rust server and tooling
  • versatiles-frontend — prebuilt frontend bundle
  • versatiles-style — map styles and sprites
  • versatiles-generator — OSM tile generation
• Not sure where it belongs? Open it anywhere — we'll move it.

Get in touch

Drop in on #versatiles:matrix.org for questions, ideas or design discussions.