-
Notifications
You must be signed in to change notification settings - Fork 17
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
Significant docs extension and restructuring #332
Conversation
Codecov Report
@@ Coverage Diff @@
## main #332 +/- ##
=======================================
Coverage 93.93% 93.93%
=======================================
Files 58 58
Lines 3495 3495
=======================================
Hits 3283 3283
Misses 212 212
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
|
I didn't mind "Important Classes." Other options: "Main Classes" "SCICO Classes" "Main SCICO Classes". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a fine way to incorporate the JOSS material. Consider moving "SCICO Contributors" outside the "User Documentation" section. Could be a part of "Developer Documentation" (a stretch, but no more a stretch than its current location) or a top-level section on its own. Or a subsection at the bottom of "Overview".
I am OK with "Main SCICO Classes" or "Core SCICO Classes". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes a nicer and more comprehensive introduction to SCICO.
A nit-picking: I would prefer for each of the Base (Main) Classes to have their own page as before.
Thanks for the suggestions. I'm inclined to go with "Main SCICO Classes". |
I agree it doesn't really belong there, but it also doesn't seem to warrant its own top-level section. I'll play around a bit to see what seems to work. |
I do see the benefit of each class having its own page. I made the change primarily because the class index page was really ugly, and inconsistent with the style of the rest of the docs. I'm open to suggestions for how to separate them again in a way that avoid the ugly index page. |
Add content that was removed from JOSS paper and restructure TOC for more rational ordering.