Expand documentation #75
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…er development; also made the quickstart section a bit less verbose.
…ilename for a high-level overview o fthe system
paulnpdev
approved these changes
Jul 15, 2024
…ade some style changes
|
I have updated this based on feedback from Paul and another self-review. I have improved the images, scaling them to a more appropriate size and making them sharper (as needed). I'm going to merge this now, since I believe this represents a major improvement to the documentation currently on |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was changed
I wrote documentation to explain the design and operation of the OMS.
Why?
To accelerate a reader's understanding of what the application does and how it works.