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.

Sign up for GitHub

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

Jump to bottom

Move root README to the 'notebooks' folder, replace with a general README #72

Open
battistowx opened this issue Feb 29, 2024 · 1 comment
Open

Move root README to the 'notebooks' folder, replace with a general README #72

battistowx opened this issue Feb 29, 2024 · 1 comment
Labels
enhancement New feature or request
Milestone
v2024.07.01

Comments

@battistowx
Copy link
Contributor

The original README contains links to each notebook, stored in the 'notebooks' subfolder. However, since more subfolders have been added with their own READMEs, this suggestion proposes to move that README into the 'notebooks' folder, and have a general README in the root directory containing descriptions and links to each subfolder and other information.
@battistowx battistowx added the enhancement New feature or request label Feb 29, 2024
@battistowx battistowx changed the title Move root README to the 'notebook's folder, replace with a general README Move root README to the 'notebooks' folder, replace with a general README Feb 29, 2024
@battistowx
Copy link
Contributor Author

battistowx commented Mar 4, 2024 •
edited

Extra suggestion from @tjhearty: add a "Libraries" column to the READMEs, but figure out a way to make them not a super long list. Might be something to add to UUI as well for searchability.

Also from @jmalfred: A general article under "Tools" to describe this repo would be useful.

@battistowx battistowx added this to the v2024.07.01 milestone Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
v2024.07.01
Development

No branches or pull requests
1 participant
@battistowx