Contributing to Sinew

Welcome! This section explains how to contribute to the Sinew project, including the docs site and the Kotlin/Dart library implementations.

Sinew is organized as a single umbrella repository with two language submodules and a Docusaurus documentation site:

Where to contribute

If your change affects only one language, open an issue/PR targeted to that submodule path (kotlin-lib/ or dart-lib/).
If it affects cross-cutting design or the documentation website, open it in the root repository and/or the docs/internal/ or docs/usage/ folder as appropriate.

Start with the design

Guide: what Sinew is, the architecture, the error model, every package with its Kotlin and Flutter implementation, the roadmap and the decisions.

Quick links

Docs authoring tips

The Guide pages (docs/internal/development/guide) are generated from the Sinew design notes by docs/internal/scripts/sync_vault.py. Don't edit them by hand: change the notes and re-run the script. The sidebars follow the folders.
Each generated page has a Concept part (shown for every language) and an Implementation part (Kotlin or Dart, picked with the language switcher).
For hand-written pages, use the KotlinOnly, DartOnly and LangTabs components for Kotlin/Dart content so readers keep their preferred language across pages.

Code of Conduct Participation is governed by the Code of Conduct files in each submodule. For sensitive reports, email [email protected].