DEV Community

Discussion on: Where do you store GitHub README.md assets?

Collapse
christianmoliveira profile image
Christian Menezes

I usually create a .github folder within the repo at the root.

Collapse
billraymond profile image
Bill Raymond

I’m totally saying this knowing so very little knowledge, but you might want to reconsider this approach. With GitHub actions now living under the .github folder, they may decide to expand on the use of that folder in the future, making it their little world to add more features your repo can take advantage of. Putting your docs under that folder may be fine forever, but just thinking out loud you might want to reconsider the specific folder you use.

Collapse
michaelcurrin profile image
Michael Currin

Agree. It already has a purpose.

Also, reading docs with images in them works outside of GitHub, such as in a markdown viewer in your IDE.