flow icon indicating copy to clipboard operation
flow copied to clipboard

Problems with syncing overiew and readme

Open devbugging opened this issue 3 years ago • 1 comments

The current implementation of the docs requires the README to be synced with /docs/overview.md. It's very easy to forget to sync both documents so that should be solved somehow. I suggest that we can default to /docs/README.md that way GitHub will still display the README at root according to https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes

devbugging avatar Jul 25 '22 13:07 devbugging

not the best solution (given the content overlap), but could we do the following:

  • keep the readme for github users landing on the repo. link to the overview page for for user-friendly documentation
  • keep the overview to serve the docs content

thoughts?

alxflw avatar Jul 25 '22 17:07 alxflw