mirror of
https://github.com/Redocly/redoc.git
synced 2025-08-08 06:04:56 +03:00
Create CONTRIBUTING-DOCS.md
This commit is contained in:
parent
f3c8ea0ee3
commit
d36cc9a618
27
.github/CONTRIBUTING-DOCS.md
vendored
Normal file
27
.github/CONTRIBUTING-DOCS.md
vendored
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
# Contributing to documentation
|
||||||
|
|
||||||
|
This documents guides you through the process of contributing to the Redocly documentation. Make sure you've read the guide for [Contributing to Redocly](CONTRIBUTING.md).
|
||||||
|
|
||||||
|
## Your first contribution
|
||||||
|
|
||||||
|
All docs can be found [here](https://github.com/Redocly/redoc). You'll need a GitHub account to contribute.
|
||||||
|
|
||||||
|
If you’re not sure where to start, check out some of our [open docs issues](https://github.com/Redocly/redoc/labels/docs).
|
||||||
|
|
||||||
|
When you’ve identified an issue you want to address, please comment on the issue to let other people know your intentions.
|
||||||
|
|
||||||
|
If you encounter any misspellings, please let us know by submitting an issue (or just fix them if they are minor changes).
|
||||||
|
|
||||||
|
## Join our community
|
||||||
|
|
||||||
|
--- Redoc.ly needs public Slack channels, including a docs channel.
|
||||||
|
|
||||||
|
## Style and formatting
|
||||||
|
|
||||||
|
Redoc.ly documentation is written using [Markdown](https://en.wikipedia.org/wiki/Markdown).The [documentation website](https://redoc.ly/docs) shows the finished product.
|
||||||
|
|
||||||
|
### Style guide
|
||||||
|
|
||||||
|
Please review [Redocly's style guide](style-guide.md)
|
||||||
|
|
||||||
|
For all else, Redoc.ly follows the [Microsoft Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/).
|
Loading…
Reference in New Issue
Block a user