Design standards README.md root files

[andyoknen]

Problem

I think we need to develop a common standard for file management README.md for all our repositories.

The introduction of a single standard will make it easier to navigate the infrastructure and will have different access points to the necessary information through the documentation portal.

Deeper documentation should be located in one place, where it will be intuitively easy to find and study, instead of exploring many repositories.

Explainer link

https://github.com/andyoknen/roadmap/tree/main/explainers/readme-standard

[gked]

I think it's a great idea. Standardizing repo's readme files will enable an easier onboarding experience for newcomers and the same expectations within the contributor community.

[gked]

One question I had was where would you want to hold the template Readme.md file? In get.started repo?

[andyoknen]

One question I had was where would you want to hold the template Readme.md file? In get.started repo?

New repositories won't be created as often, so it doesn't make sense to publish them in get.started. The explainers archive in roadmap seems to me to be a good place. What do you say?

[gked]

Makes sense.

[andyoknen]

Then it remains for us to decide on the content readme.md - my example is the result of a very short study, I haven't discussed it with anyone yet.

[gked]

@andyoknen I've suggested a couple of edits there but from where I stand, it's a good start.