MHKiT-Software / MHKiT

MHKiT Documentation
https://MHKiT-Software.github.io/MHKiT/
4 stars 14 forks source link

Reorganization of documentation sections #66

Closed akeeste closed 6 months ago

akeeste commented 6 months ago

This PR heavily reorganizes the structure of the documentation to condense the top-level table of contents. It also moves the breakdown of Python vs MATLAB features to the lowest level, instead of being visible at the topmost level of the documentation. The actual content of the documentation is largely unchanged, just restructured:

Attaching a bunch of screenshots of the TOC tree so that the build is easier to view: image

image

image

image

simmsa commented 6 months ago

@akeeste, overall this looks like a nice reorganization! I think everything looks good. The organization of the Examples section is a nice improvement.

My only questions are with the "Examples" section:

Screenshot 2024-05-16 at 2 00 05 PM

simmsa commented 6 months ago

@akeeste, I figured out a solution to increase the container width of a page (screenshots below), but it it makes all of the documentation pages wider. This is fine for the examples, but other pages with large paragraphs of text become much harder to read. I can probably work to find a solution to only make the examples page wider, but it will take some more digging. Let me know if this an avenue you would like to explore for displaying the examples and I can put it in more effort. Screenshot 2024-05-17 at 9 05 53 AM Screenshot 2024-05-17 at 9 09 19 AM

ssolson commented 6 months ago

If you guys decide to adjust the default page margins please check that the modification look good (or at least not any worse) on mobile and has good responsiveness by hitting F12 and dragging the side panel and selecting a phone view from the presets. image

akeeste commented 6 months ago

@simmsa @ssolson I think enabling a different page width or allowing lines to wrap once per table block could make that table more readable, given that changes don't affect the mobile view as @ssolson pointed out. The table is pretty long though and can horizontal scroll already. I'd prefer to merge this new reorganization and further improve the formatting in another PR