Support for Resource Groups #33
Closed
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
…d increasing header levels for any Resources and Actions belonging to a group
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.
Added support for Resource Groups by extending the ideas discuss in #6 .
This implementation introduces a Group annotation and a Group section object so that multiple different resources can be associated to the same group. This allows levels to be tracked so that the Markdown header levels can be properly increased for any Resource or Action belonging to a Group.
If there are any resources without a group, they appear at the top of the generated documentation otherwise they would be associated with the last group since Resources are considered part of the previous group until another one is defined.
This doesn't add a Group description yet. This could be unusual to handle since there could incorrectly be differing descriptions on different controllers. The first description encountered could be used.
Another option to enhance this would be a sort priority so that groups could be arranged in a desired order.