docs: revamp documentation

[john-halloran]

I don't think this PR is anywhere close to done, but since documentation is not my expertise, I've made it a draft in order to get feedback on what needs to be added. I still think rushing a release is a good idea, so this need not be perfect. The basic goal should be that someone unfamiliar with the software has enough information to know how to load their data and run the program.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (john-development@f10029a). Learn more about missing BASE report.

Additional details and impacted files

@@                 Coverage Diff                 @@
##             john-development     #182   +/-   ##
===================================================
  Coverage                    ?   77.50%           
===================================================
  Files                       ?        3           
  Lines                       ?       40           
  Branches                    ?        0           
===================================================
  Hits                        ?       31           
  Misses                      ?        9           
  Partials                    ?        0           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sbillinge]

I agree that we don't need comprehensive docs initially, so we just need to get this to a point where there are minimal docs explaining how to install and how to get started. The default docs from scikit-package are a good start, unchanged, pointing to installation instructions in the README (so we don't have to maintain them in two places), the basic thing of what the package does (also in the readme, but copy-paste this over) and getting started (what you type to make it run).

Later we can add some examples. An example of good docs I think are Caden's in diffpy.cmi, but they are further along.. The docstrings auto-build into the API docs so you don't have to write that (also the default from skpkg) as long as you have written good docstrings.

Can you try and do those things and build the docs and paste images in here as it is too much effort during reviewing to actually build the docs. YOu dojn't have to paste every page, just the top level and any key parts you want reviewed.

[sbillinge]

@john-halloran I merged this PR because when I change the URL you will want to blow away your local and reclone. You don't have to, but this can save headaches, and it is cleaner if you don't have any local branches you have to migrate over.