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

Improve the docs #13

Open
kwinkunks opened this issue Jan 31, 2022 · 3 comments
Open

Improve the docs #13

kwinkunks opened this issue Jan 31, 2022 · 3 comments
Labels
enhancement New feature or request

Comments

@kwinkunks
Copy link
Member

The README is fine but leaves a lot of unanswered questions.

A directory tree diagram showing the structure of a set of courses would be good.

We need to document how the info, hide and exercise cells work in the notebooks. Etc.

@kwinkunks kwinkunks added the enhancement New feature or request label Jan 31, 2022
@mtb-za
Copy link
Contributor

mtb-za commented Feb 10, 2022

It looks like you addressed the comments above in 21571c1 ?

We can always add more, but is there anything that you think is obviously outstanding?

@kwinkunks kwinkunks reopened this Feb 24, 2022
@kwinkunks
Copy link
Member Author

This issue was actually not affected by 21571c1

@kwinkunks
Copy link
Member Author

So far we have nothing that details how one should build a notebook for the class, eg using info, hide, and exercise tags.

Should probably do it at least partly by improving the notebooks that are bundled in include (whilst keeping them very small -- but at least one of them should be a more complete demo of the features we use).

And I think a directory tree diagram would be useful, as generated by tree on Linux.

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

No branches or pull requests

2 participants