Improve Logical Flow of Documentation

[CSSFrancis]

Description of the change

I feel like I always get lost in the Rosettasciio documentation. Most of the time I just want to go to this page https://hyperspy.org/rosettasciio/user_guide/supported_formats/index.html but it's always like 2-3 levels down. I also
almost end up going to the File Specifications page first.

Rosettasciio has a lot of documentation but it's not apparent from the home page :)

Progress of the PR

• Grid to Front Page
• Make User Guide Look Cleaner
• ready for review.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.84%. Comparing base (d54f7d1) to head (c257bf2).
Report is 23 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #324      +/-   ##
==========================================
+ Coverage   87.67%   87.84%   +0.16%     
==========================================
  Files          83       85       +2     
  Lines       11149    11179      +30     
  Branches     2414     2280     -134     
==========================================
+ Hits         9775     9820      +45     
  Misses        860      860              
+ Partials      514      499      -15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jlaehne]

Very good initiative, I have the same experience. But lets have a grid directly on the start page (similar to https://hyperspy.org/exspy/ ), so that one can get to the supported formats with one click!

[jlaehne]

I think you need to add the extension "sphinx_design" to make the grid work.

[CSSFrancis]

@jlaehne What do you think the User Guide should show? It might be nice to just jump straight to installation and have people use the side bar for something else?

[jlaehne]

@jlaehne What do you think the User Guide should show? It might be nice to just jump straight to installation and have people use the side bar for something else?

As all sections are now accessible from the front page as well that would indeed make sense.

Also, I think the table of contents on the front page could be dropped now.

Finally, I would put API before file specifications both in the header and the grid.

[ericpre]

Thank you @CSSFrancis, this has been bugging me for a while too and these changes are useful!
Most of the time, what we need to access is the "Supported formats" section and it would much better to have the link in the top bar too. I don't know if this is possible without taking that section out of the "User guide" section - in which case, the user guide could be simplify to installation, a couple of example on how to and link to the Supported formats" section.

[jlaehne]

There are some formatting issues in the preview that should be related to indentation errors.

[jlaehne]

Suggested change

	Information on scripts and packages that allow opening data saved using
	RosettaSciIO with third-party programs.
	Information on scripts and packages that allow opening data saved using
	RosettaSciIO with third-party programs.

[jlaehne]

Suggested change

	Links to or documentation of file specifications for
	some of the formats supported by RosettaSciIO.
	Links to or documentation of file specifications for
	some of the formats supported by RosettaSciIO.