Rename doc files and fix typos

[yucongalicechen]

closes #238
@bobleesj I can have some feedback before @sbillinge reviews it

[yucongalicechen]

fix typo

[github-actions]

Warning! No news item is found for this PR. If this is a user-facing change/feature/fix,
please add a news item by copying the format from news/TEMPLATE.rst.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (112d0a1) to head (c982502).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #246   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          380       380           
=========================================
  Hits           380       380           

[bobleesj]

closes #238

@bobleesj I can have some feedback before @sbillinge reviews it

Have you rendered the docs locally to check all links are populated and no broken links?

[yucongalicechen]

closes #238
@bobleesj I can have some feedback before @sbillinge reviews it

Have you rendered the docs locally to check all links are populated and no broken links?

Yep, I just built them locally and every link works. Here's a screenshot:

[yucongalicechen]

The transforms example was displayed improperly. I edited it and it's working now.

[yucongalicechen]

@bobleesj in the docstring the XQUANTITIES is not showing. Shall I open a new issue or just comment on #239?

[bobleesj]

@bobleesj in the docstring the XQUANTITIES is not showing. Shall I open a new issue or just comment on #239?

yes please open the issue!

[bobleesj]

Lovely, looks good to me

[bobleesj]

good catch

[yucongalicechen]

thanks @bobleesj ! @sbillinge ready to review now!

[sbillinge]

@bobleesj in the docstring the XQUANTITIES is not showing. Shall I open a new issue or just comment on #239?

yes please open the issue!

This may not fix. We will have to see. It depends if that unpack can be made to be done dynamically during the doc builds or not. If it doesn't fix it is honestly OK to have it like this in the API docs which are generally "developer-facing" and not "user-facing" and I would expect a developer to be able to figure out what is going on