Skip to content

Commit 301e2c6

Browse files
authored
Merge pull request #25 from jorge-campo/readme-file-and-other-minor-updates
Add README.md file and other minor fixes
2 parents bc42acc + 74e7451 commit 301e2c6

File tree

4 files changed

+35
-3
lines changed

4 files changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
1-
# help.status.im
2-
Status app user documentation
1+
# Status user documentation
2+
3+
![Status Help illustration](./overrides/assets/images/status-help-image.png)
4+
5+
This repository contains the documentation website code and Markdown source files for [help.status.im](https://help.status.im).
6+
7+
We use [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to build the user documentation site.
8+
9+
## Repository branches and git workflow
10+
11+
This repository uses a simplified version of the Gitflow git branching model from [Vicent Driessen](https://nvie.com/posts/a-successful-git-branching-model/):
12+
13+
- The `master` branch stores the official release history, and the `develop` branch serves as an integration branch for new content or fixes.
14+
- The `develop` branch contains the complete history of the documentation project, whereas the `master` branch contains an abridged version.
15+
- Each new content should reside in its own topic branch. Topic branches use `develop` as their parent branch.
16+
- New content and fixes become part of the `develop` branch via [pull request collaboration](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). When a feature is complete, it gets merged back into `develop`.
17+
- Once `develop` has acquired enough content for a release, we merge the develop branch into `master`.
18+
19+
The [Status' Docs team](https://github.com/orgs/status-im/teams/docs) works adding new content and fixes into the develop branch, and periodically merging updates with the master branch. You can keep track of the different documentation updates in the [releases](https://github.com/status-im/help.status.im/releases) page.
20+
21+
## Contributing
22+
23+
See the [contributing guide](https://github.com/status-im/help.status.im/blob/master/CONTRIBUTING.md) for detailed instructions on how to collaborate with our project.
24+
25+
We accept different types of contributions, including some that don't require you to deal with git or GitHub.
26+
27+
On every article in the Status user documentation, you can click the edit ![Edit button](./overrides/assets/icons/edit_black_24dp.svg) button to open a pull request for quick fixes like typos, updates, or link fixes.
28+
29+
For more complex contributions, you can [open an issue](https://github.com/status-im/help.status.im/issues/new/choose) using the most appropriate issue template to describe the changes you'd like to see.
30+
31+
If you're looking for a way to contribute, you can scan through [our existing issues](https://github.com/status-im/help.status.im/issues) for something to work on. When ready, check our [contributing guide](https://github.com/status-im/help.status.im/blob/master/CONTRIBUTING.md) for detailed instructions.
32+
33+
## License
34+
35+
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](https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE).

mkdocs.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.
28 KB
Loading
-3.22 KB
Binary file not shown.

0 commit comments

Comments
 (0)