saintmalik / awesome-oss-docs

📚 A curated list of awesome open source documentation for people whole love contributing to docs (Documentarians).
https://awesome-oss-docs.vercel.app
Creative Commons Zero v1.0 Universal
111 stars 62 forks source link

docs: ✏️ added apple opensource projects docs #41

Closed Sproff closed 3 years ago

Sproff commented 3 years ago

✅ #30

saintmalik commented 3 years ago

You have no issues with the Markdown Links check, but for the linting you have one.

The error says ✖ 155:86 "’" is used without matching "‘"

remark-lint:match-punctuation - Ensures punctuations are used in pairs if necessary.

More Details: This Warning comes up when punctuations are not matched. For example, when there is only left parenthesis without right parenthesis, or when right parenthesis is before left parenthesis.

Only punctuations with left/right difference will be included to check, such as Chinese quotation marks, parenthesis, angle quotes, etc. Currently, plugin will check the usage of following punctuation:

“”, 『』, (), 《》, 「」, 【】, ‘’

saintmalik commented 3 years ago

✅ #30

I also noticed something, you are creating your pull request straight from your main branch, thats a bad practice, you need to always create your own branch and send PRs from there, to avoid getting your PR closed or causing conflicts in the code base or repository next time.

saintmalik commented 3 years ago

✅ #30

Lastly, look at this documentation page that you added, https://swift.org/documentation/ , Visiting this page, you will notice that in the documentaion there isnt any quick way to make chnages like this Edit on GitHub button that is always at the button or a edit pen at the sidebar around the top corners.

How will beginners fiind the repo of this dicumentation so they can make contributions? by finding the repository of the documentation web pages.

So any documentation page that doesn't have the Edit button on their documentation web pages, its actually good for one to provide the GitHub Repository for them alongside.

Also looking at an Apple OSS Docs that you added https://github.com/apple/password-manager-resources, this OSS Project doesn't have a live documentation web page, that makes it invalid OSS Docs here.

Looking at the Dropbox changes you made, you were inserting the github repo only and not the live documentation page URL and infact you didnt do your checks well, you inserted alot of inactive and archived projects 👀.

Thanks once again

saintmalik commented 3 years ago

✅ #30

You added this Zulip - Powerful open source group chat. under Dropbox OSS Docs, but this happens to be an organisation that host alot of Projects entirely 👀.

Sproff commented 3 years ago

✅ #30

You added this Zulip - Powerful open source group chat. under Dropbox OSS Docs, but this happens to be an organisation that host alot of Projects entirely 👀.

✅ #30

I also noticed something, you are creating your pull request straight from your main branch, thats a bad practice, you need to always create your own branch and send PRs from there, to avoid getting your PR closed or causing conflicts in the code base or repository next time.

Noted, thanks.