Repository navigation
Update the documentation guide within the development guide - #1156
Merged
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1156 +/- ##
=======================================
Coverage ? 96.98%
=======================================
Files ? 71
Lines ? 7026
Branches ? 0
=======================================
Hits ? 6814
Misses ? 212
Partials ? 0 Continue to review full report at Codecov.
|
I wanted to keep this quick, but still show some examples because we do still end up using Markdown quite a lot.
rocco8773
requested changes
Jun 2, 2021
Co-authored-by: Erik Everson <[email protected]>
rocco8773
reviewed
Jun 2, 2021
Member
Author
|
Co-authored-by: Erik Everson <[email protected]>
Co-authored-by: Erik Everson <[email protected]>
Co-authored-by: Erik Everson <[email protected]>
namurphy
enabled auto-merge (squash)
July 22, 2021 19:52
rocco8773
approved these changes
Jul 25, 2021
This was referenced Jul 26, 2021
4 of 8 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 goal of this PR is to expand the documentation within our development guide on how to write documentation in order to make it more complete and accessible to new contributors. This is in preparation for Plasma Hack Week.
Here's an incomplete list of things I'm planning. I'll probably edit this list as we go.
plasmapy_sphinxand create an issue on adding more information on it to the documentation guide