-
Notifications
You must be signed in to change notification settings - Fork 84
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
Update the index of the documentation #1402
Conversation
…per parts similar to HDMF
…developer instructions
Codecov Report
@@ Coverage Diff @@
## dev #1402 +/- ##
==========================================
- Coverage 77.31% 77.26% -0.05%
==========================================
Files 37 37
Lines 2715 2714 -1
Branches 450 450
==========================================
- Hits 2099 2097 -2
Misses 535 535
- Partials 81 82 +1
Continue to review full report at Codecov.
|
@oruebel is this ready to merge? If so, please Squash and Merge. |
@rly can you please re-approve. I had to resolve minor merge conflicts in the CHANGELOG and a heading of a tutorial in order to catch the PR up with dev, so that your review was dismissed. Otherwise, this is good to merge. Feel free to squash and merge. |
Motivation
Fix #1401 This PR enhances the index of the documentation and cleans up numerous issues with regard to duplicated and outdated items.
Getting Started
section for users, aResources
section for further reading, aFor Developers
section for everything related to development, and aContributing
section with all legal items.overview_intro.rst
which included only basic text already discussed on the main landing pageoverview_nwbfile.rst
with the NWB basics tutorialResources
section to move developer-focused items to theFor Developers
sectionTutorials
to theGetting Started
chapter to make them easier to findRemaining issues
overview_software_architecture.rst
and refer to the HDMF docs for details. Created Update software architecure docs #1429 to document this issue to be addressed in a separate PR.Checklist
flake8
from the source directory.