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

Significant docs extension and restructuring #332

Merged
merged 20 commits into from
Sep 9, 2022
Merged

Conversation

bwohlberg
Copy link
Collaborator

Add content that was removed from JOSS paper and restructure TOC for more rational ordering.

@codecov
Copy link

codecov bot commented Sep 6, 2022

Codecov Report

Merging #332 (a5cc09c) into main (98d3df7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #332   +/-   ##
=======================================
  Coverage   93.93%   93.93%           
=======================================
  Files          58       58           
  Lines        3495     3495           
=======================================
  Hits         3283     3283           
  Misses        212      212           
Flag Coverage Δ
unittests 93.93% <ø> (ø)

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.

@bwohlberg
Copy link
Collaborator Author

Base Classes is perhaps not the best title since that section also includes BlockArray, which is not primarily intended as a base for derived classes. Any suggestions for alternatives?

@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label Sep 7, 2022
@Michael-T-McCann
Copy link
Contributor

Base Classes is perhaps not the best title since that section also includes BlockArray, which is not primarily intended as a base for derived classes. Any suggestions for alternatives?

I didn't mind "Important Classes." Other options: "Main Classes" "SCICO Classes" "Main SCICO Classes".

Copy link
Contributor

@Michael-T-McCann Michael-T-McCann left a 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".

@crstngc
Copy link
Contributor

crstngc commented Sep 7, 2022

Base Classes is perhaps not the best title since that section also includes BlockArray, which is not primarily intended as a base for derived classes. Any suggestions for alternatives?

I didn't mind "Important Classes." Other options: "Main Classes" "SCICO Classes" "Main SCICO Classes".

I am OK with "Main SCICO Classes" or "Core SCICO Classes".

Copy link
Contributor

@crstngc crstngc left a 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.

@bwohlberg
Copy link
Collaborator Author

Base Classes is perhaps not the best title since that section also includes BlockArray, which is not primarily intended as a base for derived classes. Any suggestions for alternatives?

I didn't mind "Important Classes." Other options: "Main Classes" "SCICO Classes" "Main SCICO Classes".

Thanks for the suggestions. I'm inclined to go with "Main SCICO Classes".

@bwohlberg
Copy link
Collaborator Author

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 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.

@bwohlberg
Copy link
Collaborator Author

A nit-picking: I would prefer for each of the Base (Main) Classes to have their own page as before.

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.

@bwohlberg bwohlberg linked an issue Sep 7, 2022 that may be closed by this pull request
@bwohlberg bwohlberg merged commit 360b670 into main Sep 9, 2022
@bwohlberg bwohlberg deleted the brendt/docs-overview branch September 9, 2022 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GPU installation update for SCICO
3 participants