Use field list for user inputs during cookiecut, overall improve language for getting started and cookiecutter guide

[bobleesj]

I added some handy features that improve our cookiecutter doc:

1. Adopt visual elements using admonish feature in Sphinx

Here is a gentle warning:

2. Use "field list" feature https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/lists_tables.html#field-list

-> it is easier to manage than using a table in .rst

3. Provide a higher-level overview of the cookiecutting process for new users:

[bobleesj]

@sbillinge ready for review -

I believe I need 3-4 more PR iterations before I feel comfortable saying it's ready for full review (using rendered doc to review all together). Just pushing PRs along the way so that each PR doesn't become too bloated.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (docs@1e0d520). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             docs     #214   +/-   ##
=======================================
  Coverage        ?   50.00%           
=======================================
  Files           ?        2           
  Lines           ?       18           
  Branches        ?        0           
=======================================
  Hits            ?        9           
  Misses          ?        9           
  Partials        ?        0           

[bobleesj]

I realized that we may want to adopt

https://my-page/use-minus-sign-for-pages instead of https://my-page/user_undersocre_sign

ex) https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site

[sbillinge]

yes, I agree. I was moving in this direction with the bg-mpl-stylesheets and so on. Getting rid of underscores in URLs and filenames, and CLI args (but replacing them obviously in python code) as a standard.

[bobleesj]

I realized that we may want to adopt

https://my-page/use-minus-sign-for-pages instead of https://my-page/user_undersocre_sign

ex) https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site

@sbillinge yup noted, I will just note this in the gitlab doc

[bobleesj]

@sbillinge ready for review -

I believe I need 3-4 more PR iterations before I feel comfortable saying it's ready for full review (using rendered doc to review all together). Just pushing PRs along the way so that each PR doesn't become too bloated.

Also, I am trying to apply our new commit standard, not perfect yet, but it's cementing:

[bobleesj]

@sbillinge would it be a good idea to merge to a temp branch like docs and once we are ready, we merge to main?

[sbillinge]

I added some handy features that improve our cookiecutter doc:

1. Adopt visual elements using admonish feature in Sphinx

Here is a gentle warning:

2. Use "field list" feature https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/lists_tables.html#field-list

-> it is easier to manage than using a table in .rst

3. Provide a higher-level overview of the cookiecutting process for new users:

all really nice! I love it!

[sbillinge]

@sbillinge would it be a good idea to merge to a temp branch like docs and once we are ready, we merge to main?

ok done.