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

Improve User Guide #219

Merged
merged 64 commits into from Jun 21, 2023
Merged

Improve User Guide #219

merged 64 commits into from Jun 21, 2023

Conversation

CPBridge
Copy link
Collaborator

@CPBridge CPBridge commented Mar 8, 2023

Major update to the user guide:

  • The old user guide has now been moved to a "Quick Start" guide. I improved the SR section as it was out of date. I also added an ANN section.
  • I added a "General Concepts" section, so far the only page there is "coding", but in the future I will likely add one on coordinates, and possibly other things.
  • I have added new pages for each individual IOD with much more complete explanations. The following are finished (the remainder are placeholders for now):
    • SR
    • SEG
    • ANN

This branch has been going since 2021... It's way way past time to get this merged. Since this is purely doc changes and you are busy @hackermd , thoughts on just merging so that readthedocs gets updated and then you can review and tweak later?

@CPBridge CPBridge requested a review from hackermd June 9, 2023 21:08
@CPBridge CPBridge added documentation Improvements or additions to documentation enhancement New feature or request and removed enhancement New feature or request labels Jun 9, 2023
@CPBridge CPBridge marked this pull request as ready for review June 9, 2023 21:09
@CPBridge CPBridge self-assigned this Jun 9, 2023
Copy link
Collaborator

@hackermd hackermd left a comment

Choose a reason for hiding this comment

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

Very nice!

@CPBridge CPBridge merged commit aed7798 into master Jun 21, 2023
11 checks passed
@CPBridge CPBridge deleted the docs/seg_explanation branch June 21, 2023 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants