DEV Community

Discussion on: Blog Posts vs Docs - Where to Place Content?

Collapse
 
qew7 profile image
Maxim Veysgeym

i think that everything you need to work (even in form of links) should be in readme on github page

Collapse
 
felicianotech profile image
Ricardo N Feliciano

everything you need to work

What do you mean by this?

A README.md file on GitHub, which is a crucial file, is documentation. So I believe whatever applies to docs applies to that file. Meaning theory, news, etc shouldn't be there. Instructions, intro, description, should.