Update docs on updating docs #259
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
…OMRSE documentation
Replaced pointer to ODK managing docs to OMRSE-specific instructions for managing docs
Some fixes plus added key point to only add documentation of classes, definitions, etc. in the modeling folder.
Added section on deployment of docs
Cleanup, clarification, added link
Trying to fix link to ManageDocumentation.md
|
looks good to me too |
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.
We decided to use the ODK's "make update_docs" workflow for publishing OMRSE docs on GitHub Pages. However, we want to ensure that everyone does their changes on a branch and has them reviewed before merging them into the main branch. Also, final deployment to GitHub Pages should be done only from the main branch. And also, we want to be clear that all documentation of modeling decisions are made in the modeling folder.
Therefore, I updated the documentation to describe the procedure, attempting to follow the procedure as I described it. This branch & pull request is for review, comment, and finalization before the merger into main (per the procedure!)