This repository contains the writing style guide for Status documentation hosted on write.status.im.
We use Material for MkDocs to build the user documentation site.
This repository uses a simplified version of the Gitflow git branching model from Vicent Driessen:
- The
masterbranch stores the official release history, and thedevelopbranch serves as an integration branch for new content or fixes. - The
developbranch contains the complete history of the documentation project, whereas themasterbranch contains an abridged version. - Each new content should reside in its own topic branch. Topic branches use
developas their parent branch. - New content and fixes become part of the
developbranch via pull request collaboration. When a feature is complete, it gets merged back intodevelop. - Once
develophas acquired enough content for a release, we merge the develop branch intomaster.
See the contributing guide for detailed instructions on collaborating with our project.
On every article in the Status user documentation, you can click the edit 
button to open a pull request for quick fixes like typos, updates, or link fixes.
For more complex contributions, you can open an issue using the most appropriate issue template to describe the changes you'd like to see.
If you're looking for a way to contribute, you can scan through our existing issues for something to work on. When ready, check our contributing guide for detailed instructions.
We build two branches using our Jenkins instance:
masteris deployed to https://write.status.im/ by CIdevelopis deployed to https://dev-write.status.im/ by CI
The Status Docs team adds new content and fixes to the develop branch and periodically merges updates into the master branch. When merging changes, we rebase on the develop branch. You can keep track of the documentation updates on the releases page.
The Status user documentation is licensed under the MIT license. The Material for MkDocs components of our documentation are licensed under the Material for MkDocs license.