Add GitHub Wiki

[alex-semenyuk]

https://github.com/MyHoneyBadger/awesome-github-wiki#readme

Project documentation is a vital part of project management that why this list can be considered as list a good documentation examples on GitHub

My reviews:
#2382
#2316
#2335

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

• Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
• You have to review at least 2 other open pull requests.
  Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions.
• You have read and understood the instructions for creating a list.
• This pull request has a title in the format Add Name of List.
  • ✅ Add Swift
  • ✅ Add Software Architecture
  • ❌ Update readme.md
  • ❌ Add Awesome Swift
  • ❌ Add swift
  • ❌ add Swift
  • ❌ Adding Swift
  • ❌ Added Swift
• Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
  • ✅ - [iOS](…) - Mobile operating system for Apple phones and tablets.
  • ✅ - [Framer](…) - Prototyping interactive UI designs.
  • ❌ - [iOS](…) - Resources and tools for iOS development.
  • ❌ - [Framer](…)
  • ❌ - [Framer](…) - prototyping interactive UI designs
• Your entry should be added at the bottom of the appropriate category.
• The title of your entry should be title-cased and the URL to your list should end in #readme.
  • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
• The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

• Has been around for at least 30 days.
  That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
• Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
• Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
• The default branch should be named main, not master.
• Includes a succinct description of the project/theme at the top of the readme. (Example)
  • ✅ Mobile operating system for Apple phones and tablets.
  • ✅ Prototyping interactive UI designs.
  • ❌ Resources and tools for iOS development.
  • ❌ Awesome Framer packages and tools.
• It's the result of hard work and the best I could possibly produce.
  If you have not put in considerable effort into your list, your pull request will be immediately closed.
• The repo name of your list should be in lowercase slug format: awesome-name-of-list.
  • ✅ awesome-swift
  • ✅ awesome-web-typography
  • ❌ awesome-Swift
  • ❌ AwesomeWebTypography
• The heading title of your list should be in title case format: # Awesome Name of List.
  • ✅ # Awesome Swift
  • ✅ # Awesome Web Typography
  • ❌ # awesome-swift
  • ❌ # AwesomeSwift
• Non-generated Markdown file in a GitHub repo.
• The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
• Not a duplicate. Please search for existing submissions.
• Only has awesome items. Awesome lists are curations of the best, not everything.
• Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
• Includes a project logo/illustration whenever possible.
  • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
  • The image should link to the project website or any relevant website.
  • The image should be high-DPI. Set it to maximum half the width of the original image.
• Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
• Includes the Awesome badge.
  • Should be placed on the right side of the readme heading.
    • Can be placed centered if the list has a centered graphics header.
  • Should link back to this list.
• Has a Table of Contents section.
  • Should be named Contents, not Table of Contents.
  • Should be the first section in the list.
  • Should only have one level of nested lists, preferably none.
  • Must not feature Contributing or Footnotes sections.
• Has an appropriate license.
  • We strongly recommend the CC0 license, but any Creative Commons license will work.
    • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
  • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
  • Place a file named license or LICENSE in the repo root with the license text.
  • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
  • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
• Has contribution guidelines.
  • The file should be named contributing.md. Casing is up to you.
  • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
  • The section should not appear in the Table of Contents.
• All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
• Has consistent formatting and proper spelling/grammar.
  • The link and description are separated by a dash.
    Example: - [AVA](…) - JavaScript test runner.
  • The description starts with an uppercase character and ends with a period.
  • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
• Doesn't use hard-wrapping.
• Doesn't include a Travis badge.
  You can still use Travis for list linting, but the badge has no value in the readme.
• Doesn't include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

[villesundell]

@alex-semenyuk Hello! 👋 It seems that you have missed some requirements from the guidelines, please read those again 📝 (Those guidelines contain a certain test.)

Also, the guidelines explicitly forbid work-in-progress PRs.

Thank you for making the world a bit more awesome 😎

[alex-semenyuk]

Hey @villesundell.
Thanks for the review
Read requirements again, don't see any explicit breaks. Could you please point what I have missed?
Thanks!

[villesundell]

@alex-semenyuk Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it.

(Also, there is a test embedded in the guidelines, but you have to find it yourself: that shows you really have read the guidelines thoroughly.)

EDIT: I mean, since there are only three entries at the moment, that list is still work-in-progress, right? The idea of gathering awesome wikis is good though 👍

EDIT2: Fixed wikis 😅

[alex-semenyuk]

Actually, it would be nice to have more, but don't see explicit count in the rules. So all of this lists is kind of WIP.)
Also, I include only Wikis pages, because we already have separate list for Readme.

[alex-semenyuk]

Unicorn

[villesundell]

@alex-semenyuk Sorry, I misunderstood this list being WIP. And yeah, you are right, there is no limit (as that would be counterproductive)

[notpresident35]

While technically there is no limit, I think that this fails the spirit of curation. I do like the concept, but at the moment, it's less of a curated list and more of a promise it will be one at some point in the future. Fleshed out a bit more, this would be a valuable contribution to the awesome community, though I am unsure of its value in its current state.

In any case, the rules state that repositories must be at least 30 days old - come back in a few weeks :3

[Electradawn]

Stop On Sep 17, 2022 1:51 PM, Hazel Kennedy ***@***.***> wrote: While technically there is no limit, I think that this fails the spirit of curation. I do like the concept, but at the moment, it's less of a curated list and more of a promise it will be one at some point in the future. Fleshed out a bit more, this would be a valuable contribution to the awesome community, though I am unsure of its value in its current state. In any case, the rules state that repositories must be at least 30 days old - come back in a few weeks :3 —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[n0kovo]

While there's no explicit lower limit to the amount of entries, I would have to agree that this probably constitutes a 'work in progress' and imo should have a bit more entries before being included.

[alex-semenyuk]

@n0kovo @notpresident35 @villesundell Thanks for your opinions.
Btw appreciate any helps to repo - pr, issues, stars which defenitly attract attention to it and make it more mature 🤗

[sindresorhus]

Incorrect title

[sindresorhus]

And I think the description could be improved.

[alex-semenyuk]

Thanks, @sindresorhus
Title fixed, Could you please elaborate what can be improved.

[sindresorhus]

I would rewrite the sentence to not use commas and change around the order. Currently it doesn't read that well.

[sindresorhus]

Something like:

Comprehensive documentation on GitHub beyond README.

[alex-semenyuk]

unicorn

[alex-semenyuk]

@sindresorhus any more suggestions on this?
Thanks!

[sindresorhus]

For the https://github.com/MyHoneyBadger/awesome-github-wiki#examples section, I think it would be useful to have a description of why these are awesome and good examples.

[sindresorhus]

GitHub wiki directories

Use consistent capitalisation.

[alex-semenyuk]

Unicorn

@sindresorhus done

[sindresorhus]

Tweet: https://twitter.com/awesome__re/status/1650224538763022336