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

Proper Documentation #14

Closed
4 tasks
avik-pal opened this issue Jul 23, 2020 · 0 comments · Fixed by #19
Closed
4 tasks

Proper Documentation #14

avik-pal opened this issue Jul 23, 2020 · 0 comments · Fixed by #19

Comments

@avik-pal
Copy link
Member

The current documentation does a good job of listing the API but is difficult for a beginner to parse. Listing down a few improvements here. Will update the list as we go forward:

  1. Add more structure to the docs.
    • There must be clear instructions to install the package.
    • Separate pages for different representations
    • Explain the Mesh representation a bit. It is not clear how the different formats are useful.
    • Have a different page listing the available set of metrics/loss functions
  2. The examples should be displayed in the Documentation itself, and follow a format where the entire executable code is listed at top and followed by a step-by-step explaination. Look at https://diffeqflux.sciml.ai/dev/ for inspiration.
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

Successfully merging a pull request may close this issue.

1 participant