rhetenor/awesome-awesomeness
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update and add index

Browse Source
This commit is contained in:
Jonas Zeunert
2024-04-23 15:17:38 +02:00
parent 4d0cd768f7
commit 8d4db5d359
726 changed files with 41721 additions and 53949 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
terminal/githubwiki
View File

@@ -1,12 +1,10 @@
 Awesome GitHub Wikis !Awesome (https://awesome.re/badge.svg) (https://awesome.re) !Awesome Lint 
 (https://github.com/MyHoneyBadger/awesome-github-wiki/actions/workflows/action.yml/badge.svg?branch=main) 
 (https://github.com/MyHoneyBadger/awesome-github-wiki/actions/workflows/action.yml?query=branch%3Amain) !Track Awesome List (https://www.trackawesomelist.com/badge.svg) 
 (https://www.trackawesomelist.com/MyHoneyBadger/awesome-github-wiki/)
 Awesome GitHub Wikis !Awesome (https://awesome.re/badge.svg) (https://awesome.re) !Awesome Lint (https://github.com/MyHoneyBadger/awesome-github-wiki/actions/workflows/action.yml/badge.svg?branch=main) 
 (https://github.com/MyHoneyBadger/awesome-github-wiki/actions/workflows/action.yml?query=branch%3Amain) !Track Awesome List (https://www.trackawesomelist.com/badge.svg) 
 (https://www.trackawesomelist.com/MyHoneyBadger/awesome-github-wiki/)
▐ A curated list of awesome GitHub Wikis
Every repository on GitHub.com (https://github.com/) comes equipped with a section for hosting documentation, called a Wiki 
(https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis). Repository's Wiki shares long-form content about project, such as how to use it, how you designed it,
or its core principles. A README file quickly tells what project can do, while use a Wiki to provide additional documentation.
Every repository on GitHub.com (https://github.com/) comes equipped with a section for hosting documentation, called a Wiki (https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis). Repository's Wiki 
shares long-form content about project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what project can do, while use a Wiki to provide additional documentation.
Contents
- Examples (#examples)
@@ -14,8 +12,8 @@
- Useful Stack Overflow questions & answers (#useful-stack-overflow-questions--answers)
Examples
Wiki should be detail, up to date and well structured. It should be easy to find required information and navigate through the pages. Use rich possibilities of Markdown in Wiki formatting. 
Wiki doesn't fully repeat information which is already presented at README. The following list of examples represents mentioned good practices: 
Wiki should be detail, up to date and well structured. It should be easy to find required information and navigate through the pages. Use rich possibilities of Markdown in Wiki formatting. Wiki doesn't fully repeat information which is 
already presented at README. The following list of examples represents mentioned good practices: 
- Netflix/Hystrix (https://github.com/Netflix/Hystrix/wiki)
- aws/aws-parallelcluster (https://github.com/aws/aws-parallelcluster/wiki)
- facebook/hhvm (https://github.com/facebook/hhvm/wiki)