search

thegooddocsproject / thegooddocsproject.github.io

The Good Docs Project website
https://thegooddocsproject.dev/
Creative Commons Attribution Share Alike 4.0 International
19 stars 16 forks source link

Write a good Readme for website repo #16

Closed flicstar closed 4 years ago

jaredmorgs commented 5 years ago

@flicstar what exactly is required here?

I see that in https://github.com/thegooddocsproject/thegooddocsproject.github.io/blob/master/index.md there is some content already about what this project is about.

Would it be better to promote this content (even copy-pasta) into a README.md at the same level as index.md?

jaredmorgs commented 5 years ago

image

What we should do is update our GitHub Repo organisation statement to put a link to our website and an overarching project description.

Steal it from the index.md file perhaps?

jaredmorgs commented 5 years ago

The other option is that we cherry-pick content out of the hanging PR in this project and make that content into the repository readme.

flicstar commented 4 years ago

Yeah, lets do one or all of those things 👍 I only created the issue because Jo said "we need good readmes". So I was just trying to be complete.

camerons commented 4 years ago

I'm closing out this issue for 0.1 release. We do have README files in our templates now. For our future releases we can create a new issue if required to improve the existing READMEs. (This is likely to happen based on feedback from reviews in the WriteTheDocs community.