Add an introductory page to the API documentation #617
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
The contents of `docs/main_page.md` will be the first thing the user sees upon browsing the API documentation. This fixes #616.
kyllingstad
requested review from
lassebje,
ljamt,
markaren,
hplatou and
eidekrist
hplatou
reviewed
Oct 7, 2020
|
Content looks good. I can't build and test the doc myself, so I can't vouch for that. |
hplatou
approved these changes
Oct 8, 2020
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.
The contents of
docs/main_page.mdwill be the first thing the user sees upon browsing the API documentation. That is, it will fill the current void below the menu here (substituting "Introduction" in place of the "libcosim Documentation" heading). All symbols link to the appropriate place in the API documentation, by Doxygen magic.This fixes #616.