Skip to main content

Design Decisions

We gebruiken GitHub voor onze code en bestanden​

GitHub is een veel gebruikte oplossing binnen Common Ground en biedt ons als open source project voldoende functionaliteit om ons project open en gratis te draaien

Alle code en documentatie word openbaar gemaakt onder EUPL-licentie​

zie de documentatie

We baseren ons op Public Code​

Afwijkingen​

  • Aan het contract object is de property phone toegevoegd voor het vasthouden van telefoonnummers

Documentation Features​

Docusaurus​

This documentation is built using Docusaurus, a modern static website generator that makes it easy to maintain open source documentation. Docusaurus provides features like:

  • Markdown support
  • Search functionality
  • Versioning
  • Internationalization
  • Theme customization
  • Plugin system

Redocusaurus​

We use Redocusaurus to integrate OpenAPI/Swagger documentation into our Docusaurus site. This allows us to:

  • Display interactive API documentation
  • Support OpenAPI 3.0 specifications
  • Customize the look and feel
  • Keep API docs in sync with the specification

Mermaid Diagrams​

This documentation supports Mermaid diagrams for creating flowcharts, sequence diagrams, class diagrams, and more.