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

Suggestion to break up the readme file into multiple files #34

Open
jkrick opened this issue Jul 1, 2024 · 0 comments
Open

Suggestion to break up the readme file into multiple files #34

jkrick opened this issue Jul 1, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jkrick
Copy link
Collaborator

jkrick commented Jul 1, 2024

Then the main readme page that GitHub page renders can be a table of contents. It will then be a readme for the repo.

Instead of a single readme.md file that we have all the documentation in, it would be better to break this into smaller files. FAQ.md, data_access.md, login.md, quick_start.md, or whatever we would want to have in the table of contents.

Then in the rendering Brigitta will make it have a table of contents. and the readme will be a readme for the repo and not the content itself.

@jkrick jkrick added the documentation Improvements or additions to documentation label Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant