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

Missing README and instructions for contributors #4

Open
wna-se opened this issue Jul 24, 2024 · 0 comments
Open

Missing README and instructions for contributors #4

wna-se opened this issue Jul 24, 2024 · 0 comments

Comments

@wna-se
Copy link

wna-se commented Jul 24, 2024

As a new contributor and first-time user or Jupyter Book the repository is a bit confusing to navigate. We could consider adding a README with links to the relevant documentation, including some minimal instructions to get started (e.g. building the book locally) and how the content is organised. We could also consider creating a folder structure that separates 1) data that is used across several scenarios from content specific to an single scenario; and 2) content that is used in the book from other content, such as examples and documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant