afrin127329 / help.status.im

Status apps user documentation

Status apps user documentation

This repository contains the documentation website code and Markdown files for help.status.im.

We use Material for MkDocs to build the user documentation site.

Repository branches and git workflow

This repository uses a simplified version of the Gitflow git branching model from Vicent Driessen:

• The master branch stores the official release history, and the develop branch serves as an integration branch for new content or fixes.
• The develop branch contains the complete history of the documentation project, whereas the master branch contains an abridged version.
• Each new content should reside in its own topic branch. Topic branches use develop as their parent branch.
• New content and fixes become part of the develop branch via pull request collaboration. When a feature is complete, it gets merged back into develop.
• Once develop has acquired enough content for a release, we merge the develop branch into master.

Contributing

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.

Continuous integration

We build two branches using our Jenkins instance:

• master is deployed to https://help.status.im/ by CI
• develop is deployed to https://dev-help.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.

License

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.