21 doc update documentation #22
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
younesStrittmatter
requested review from
hollandjg,
musslick,
chadcwilliams,
benwandrew,
TheLemonPig,
blinodelka and
whyhardt
chadcwilliams
approved these changes
Dec 11, 2023
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
make a (tiny) little bot more documentation
resolves #21
Type of change
Questions/Ideas:
I think we should eventually move the documentation to the autora-parent package instead of here. Allthough that is a bit inconvienient since code and documentaiton is in seperate repositories, we might end up linkning to parts of the documentation from other packages (for example core). In fact, this already happens here: the ref links are not in this repository but in the autora-parent repo.
Also: that will make it easier to seamlessly add optional synthetic runners to the documentation (I think the documentation of them should not be included here at all).