Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Problems with syncing overiew and readme #1068

Open
sideninja opened this issue Jul 25, 2022 · 1 comment
Open

Problems with syncing overiew and readme #1068

sideninja opened this issue Jul 25, 2022 · 1 comment
Labels
bug Something isn't working Feedback

Comments

@sideninja
Copy link
Contributor

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

@sideninja sideninja added bug Something isn't working Feedback labels Jul 25, 2022
@alxflw
Copy link
Contributor

alxflw commented Jul 25, 2022

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Feedback
Projects
None yet
Development

No branches or pull requests

2 participants