-
Notifications
You must be signed in to change notification settings - Fork 930
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
Documentation restructuring (core submodule) #1478
Comments
Hey Brian -- Dana here (my old @danagilliann is no longer accessible) 😄 I'm happy to start working on this. I can start of with
|
👋 Thanks @dana-gill , that'd be great! |
I do have to admit: Building the documentation is not very easy since the documentation for it was a bit scattered 😅 Would it make sense to propose the following issues?
Let me know what you think :) |
Yeah, I know, sorry for that! It's a complicated process because we need to maintain historical doc builds, and readthedocs isn't viable for us due to the computational overhead of running all of the examples.
If there's a way to auto-include the doc, rather than linking or converting it, that would be better. Github wants it to be CONTRIBUTING.md (though other formats might be supported) so that it's discoverable and checks off the community guidelines box.
Yeah, that's a good idea. It could also be expanded a bit to cover the doc linting and link checking we added to the CI so that people can run that locally if they want. |
Hi @bmcfee! I created a draft PR #1801 with a preview of a possible solution to restructure the documentation side bar. Before I completely proceed with a full makeover of the sidebar, could you let me know if the general idea was what you had in mind? Here's what Phase Recovery looks like, for example: Thanks! 🌻 |
👋 @dana-gill sorry this got buried in my notifications (I'm phasing back into full-time this week). But yeah, this looks like what I had in mind - thanks! |
The documentation site is generally pretty navigable, but I think the core submodule (sub-heading "Core IO and DSP") is both too large and at this point, inaccurately named.
At present, it looks as follows:
where each of those sub-sub-headings has somewhere between 2 and 12 function entries.
I think we can easily break this up into some more meaningful sections, which can be promoted to the top level of the index. Originally, I had designed the documentation index to reflect the submodule structure of the package, but I don't think that's terribly relevant anymore.
I propose that we eliminate the "Core IO and DSP" top-level heading, and replace it with the following:
I'm also open to other suggestions for top-level organization, but the above seems at least plausible and a bit easier to navigate IMO.
Are there other sections of the docs that could benefit from restructuring?
The text was updated successfully, but these errors were encountered: