status-im
/
write.status.im
mirror of https://github.com/status-im/write.status.im.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Status documentation writing style guide https://write.status.im
40 Commits 7 Branches 12 Tags 4.8 MiB
CSS 66.7%
Dockerfile 33.3%
Go to file
Jorge Campo d263741a7b
43 Writing style guide updates -- July 2023 		2023-07-11 11:50:51 +02:00
.github/ISSUE_TEMPLATE copying changes from help.status.im repo 2022-10-24 14:53:20 +02:00
config fix TOC depth and hide navigation.index setting 2023-02-10 05:29:53 +01:00
docs 43 Writing style guide updates -- July 2023 2023-07-11 11:50:51 +02:00
includes Fixing broken/missing links 2023-02-10 14:02:40 +03:00
overrides testing icons 2023-03-31 17:06:36 -03:00
.gitignore copying changes from help.status.im repo 2022-10-24 14:53:20 +02:00
CONTRIBUTING.md ci: fix Jenkinsfile and mkdocs config 2022-10-24 15:25:31 +02:00
Dockerfile copying changes from help.status.im repo 2022-10-24 14:53:20 +02:00
Jenkinsfile ci: fix Jenkinsfile and mkdocs config 2022-10-24 15:25:31 +02:00
LICENSE Initial commit 2022-03-17 11:47:53 +01:00
README.md Fixing a minor typo 2023-01-19 15:12:32 +03:00
requirements.txt 40 add pytz module to requirements.txt 2023-03-03 14:49:49 +01:00

README.md

To-do

Status Help illustration

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.

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 Edit button 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:

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.