Add module overview/introduction sections #1829
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
drkameleon
added
documentation
github-actions
bot
removed
the
documentation
…dd-module-overview-documentation
|
Ready to merge! 🚀 |
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.
Description
This PR aims to add some overview/introduction sections to the module pages.
Right now, what we have there is the title (of the module), a very short description (a one-liner actually) and the list of words defined (functions, predicates, constants).
It would be great if we followed Nim's way and added a short - and to-the-point - intro, that highlights the important details, shows parts that are not properly documented in any of the functions and shows more elaborate usage examples where appropriate.
Progress
Type of change