-
-
Notifications
You must be signed in to change notification settings - Fork 404
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add preview docs section #1383
Merged
Merged
add preview docs section #1383
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
Codecov Report
@@ Coverage Diff @@
## master #1383 +/- ##
=======================================
Coverage 72.38% 72.38%
=======================================
Files 66 66
Lines 5098 5098
=======================================
Hits 3690 3690
Misses 1408 1408 Continue to review full report at Codecov.
|
andrewfullard
approved these changes
Dec 17, 2020
atharva-2001
pushed a commit
to atharva-2001/tardis
that referenced
this pull request
Oct 1, 2021
* add preview docs section * minor changes * minor changes * change job name * minor changes * minor changes * fix typo * add suggested changes * add limitations subsection * fix code block * change index * fix some display issues * change page name * minor changes to pr template
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
Add a documentation section on how to build docs in your fork to preview changes (and check you are not breaking the docs!).
Motivation and Context
Sometimes it's useful to share a preview of changes in documentation. But the most important thing is this will help to make the pipeline break less often (if users are encouraged to preview changes in documentation before merging).
How Has This Been Tested?
See: https://github.com/epassaro/tardis/actions/
and https://epassaro.github.io/tardis/development/documentation_preview.html
Screenshots (if appropriate):
Types of changes
Checklist: