Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tidy up docs, READMEs and CONTRIBUTING across repos #141

Open
fryorcraken opened this issue Nov 27, 2023 · 0 comments
Open

Tidy up docs, READMEs and CONTRIBUTING across repos #141

fryorcraken opened this issue Nov 27, 2023 · 0 comments

Comments

@fryorcraken
Copy link
Contributor

Problem

There are docs remaining in various repos README's and /doc folder, making it duplicate with the docs website: docs.waku.org.

Docs should be easy to find from the GitHub repos, and outdated docs should be avoided.

Also, there is no CONTRIBUTING.md in some repos.

Proposed Solution

  1. Make the http://docs.waku.org/ the doc of reference.
  2. Only have README.md with rich content in the root folder of each repo, and make all other sub-README.md files to refer the appropriate http://docs.waku.org/ point.
  3. Keep the same philosophy across all repos.

Even the "main" README.md at point 2. could refer to the http://docs.waku.org/ at the end, indicating where the user can find further information about Waku.

  1. Re-instante contribute page and point to it from repo's READMEs: 590b7d8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant