docs:(readme) add first content

This commit is contained in:
sven
2019-06-14 18:23:30 +02:00
parent e49878abbf
commit 6d7cbf9d38
5 changed files with 126 additions and 2 deletions
+18
View File
@@ -0,0 +1,18 @@
Please check if what you want to add to `awesome-docs` list meets [quality standards](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#quality-standard) before sending pull request. Thanks!
**Please provide package links to:**
- github.com repo:
**Note**: that new categories can be added only when there are 3 packages or more.
**Make sure that you've checked the boxes below before you submit PR:**
- [ ] I have added my package in alphabetical order.
- [ ] I have an appropriate description with correct grammar.
- [ ] I know that this package was not listed before.
- [ ] I have added godoc link to the repo and to my pull request.
- [ ] I have added coverage service link to the repo and to my pull request.
- [ ] I have added goreportcard link to the repo and to my pull request.
- [ ] I have read [Contribution guidelines](https://github.com/testthedocs/awesome-docs/blob/master/CONTRIBUTING.md#contribution-guidelines), [maintainers note](https://github.com/testthedocs/awesome-docs/blob/master/CONTRIBUTING.md#maintainers) and [Quality standard](https://github.com/testthedocs/awesome-docs/blob/master/CONTRIBUTING.md#quality-standard).
Thanks for your PR, you're awesome! :+1:
+44
View File
@@ -0,0 +1,44 @@
# Contribution Guidelines
- **To add, remove, or change things on the list:** Submit a pull request
- List items should be sorted *alphabetically*.
- Each item should be limited to one link.
- The link should be the name of the package or project.
- Descriptions should be clear, concise, and non-promotional.
- Descriptions should follow the link, on the same line and end with a punctuation mark.
- At least 3 items are needed to create a new category.
Please contribute links to packages/projects you have used or are familiar with.
This will help ensure high-quality entries.
## Quality standards
- Generally useful to the wider community
- Actively maintained
- Regular, recent commits
- Or, for finished projects, issues and pull requests are responded to
- Stable or progressing toward stable
- Thoroughly documented (README, comments, docs, etc.) in english language, so everyone is able to understand the project's intention and how it works
## Maintainers
To make sure every PR is checked, we have [team maintainers](MAINTAINERS).
Every PR MUST be reviewed by at least two maintainers before it can get merged.
The maintainers will review your PR and notify you and tag it in case any information is still missing.
They will wait 30 days for your interaction, after that the PR will be closed.
## Reporting issues
Please open an issue if you would like to discuss anything that could be improved or have suggestions for making the list a more valuable resource.
We realize sometimes packages fall into abandonment or have breaking builds for extended periods of time, so if you see that, feel free to change its listing or let us know.
We also realize that sometimes projects are just going through transitions or are more experimental in nature.
These can still be cool, but we can indicate them as transitory or experimental.
Removal changes will not be applied until they have been pending for a minimum of 1 week (7 days).
This grace window benefits projects that may be going through a temporary transition but are otherwise worthy of being on the list.
Thanks everyone!
+5
View File
@@ -0,0 +1,5 @@
Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)
[CC4](http://creativecommons.org/licenses/by-nc/4.0/)
[Full text](http://creativecommons.org/licenses/by-nc/4.0/legalcode)
+1
View File
@@ -0,0 +1 @@
Sven <sven@testthedocs.org>
+58 -2
View File
@@ -1,2 +1,58 @@
# awesome-docs
A curated list of awesome documentation tools
# Awesome Docs
A curated list of awesome documentation tools.
*If you see a package or project here that is no longer maintained or is not a good fit, please submit a pull request to improve this file.
Thank you!*
## Contributing
Please take a quick gander at the [contribution guidelines](https://github.com/testthedocs/awesome-docs/blob/master/CONTRIBUTING.md) first.
Thanks to all [contributors](https://github.com/testthedocs/awesome-docs/graphs/contributors); you rock!
## Contents
- [Browser Extensions](#browser-extensions)
- [Browser Testing](#browser-testing)
- [Hosting](#hosting)
- [Screencast](#screencast)
- [Screenshot](#screenshot)
- [Site Generators](#site-generators)
## Browser Testing
- [Nightwatch.js](https://nightwatchjs.org/)
- [Puppeteer](https://github.com/GoogleChrome/puppeteer)
- [Selenium](https://www.seleniumhq.org/)
## Hosting
- [GitBook](https://www.gitbook.com/)
- [Netlify](https://www.netlify.com/)
- [Read The Docs](https://readthedocs.org/)
## Browser Extensions
- [Grammarly](https://www.grammarly.com/)
- [LanguageTool](https://languagetool.org/)
## Screencast
- [Asciinema](https://asciinema.org/)
- [Peek](https://github.com/phw/peek)
## Screenshot
- [Carbon](https://carbon.now.sh)
- [Flameshot](https://github.com/lupoDharkael/flameshot)
## Site Generators
- [Antora](https://antora.org/)
- [Asciidoctor](https://asciidoctor.org/)
- [Docusaurus](https://docusaurus.io/)
- [Docsify](https://docsify.js.org/)
- [MkDocs](https://www.mkdocs.org/)
- [Sphinx](https://www.sphinx-doc.org/en/master/)
- [VuePress](https://vuepress.vuejs.org/)