Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#70: update doc #75

Merged
merged 5 commits into from
May 19, 2023
Merged

#70: update doc #75

merged 5 commits into from
May 19, 2023

Conversation

ccarouge
Copy link
Member

@ccarouge ccarouge commented May 9, 2023

The changes to the documentation include:

  • change options descriptions
  • use of sub-commands instead of command line options.
  • add expected stdout
  • modify some formatting in the user guide
  • move the default science configurations to their own page to improve visibility

The documentation still needs some documentation to use me.org but it is better to move that to its own ticket I think.

- change options descriptions
- use of sub-commands instead of command line options.
@ccarouge ccarouge force-pushed the ccarouge/issue70 branch 2 times, most recently from 36f5445 to 4425b1f Compare May 15, 2023 02:00
@ccarouge ccarouge force-pushed the ccarouge/issue70 branch from 4425b1f to a2d174c Compare May 15, 2023 02:08
@ccarouge ccarouge requested a review from SeanBryan51 May 15, 2023 02:18
Copy link
Collaborator

@SeanBryan51 SeanBryan51 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a few minor suggestions which might be a bit cosmetic (feel free to ignore some suggestions).

I think we should have options in the configuration file as subsubsubheadings (with three subs), for example for science_configurations we replace

+### `science_configurations`
-`science_configurations`

And to reference the section:

This is [a link to `science_configurations`](#`science_configurations`)

Lastly, can we have permalinks for headings? This can enabled by adding the following to mkdocs.yml:

markdown_extensions:
    - toc:
        permalink: True

ccarouge added 2 commits May 19, 2023 10:37
- format options as headings
- add permanent links for headings
@ccarouge ccarouge requested a review from SeanBryan51 May 19, 2023 00:52
@ccarouge ccarouge merged commit 33b8f9e into master May 19, 2023
@ccarouge ccarouge deleted the ccarouge/issue70 branch May 19, 2023 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants