Setup basic versioned docs #896
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
Codecov Report
@@ Coverage Diff @@
## master #896 +/- ##
=======================================
Coverage 71.64% 71.64%
=======================================
Files 30 30
Lines 2409 2409
=======================================
Hits 1726 1726
Misses 577 577
Partials 106 106Continue to review full report at Codecov.
|
Merged
|
🕙 PR timeout! |
|
I have a suggestion. How about we use good old godoc for the library? That would be consistent and would allow for auto-generated and would allow for playground-style runnable examples. We can always generate a README.md from the godoc. Example link: https://go.ajitem.com/pkg/go.ajitem.com/stack/ |
asahasrabuddhe
approved these changes
Oct 23, 2019
|
@asahasrabuddhe can you create an issue about godoc? This PR isn't quite the place to have the conversation. |
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.
Motivation
My proposal for v2 release cycle requires there be versioned docs (see #826). These was also a recent issue where people discussed versioned documentation (see #877).
Context and Future Work
This isn't "true" versioned documentation, not yet at least. In the future I would like to consider mkdocs, docsify, docusaurus or similar, as mentioned in this comment #877 (comment). This specific PR is focused only on setting up a
v1andv2folder so that #892 won't have to deal with merge conflicts. Judge this PR by that parameter, eg, does this PR help make #892 easier?Changes
docsfolderdocsfolder. the code of conduct has not been moved because (I think) github looks for it in the root directory (I'll explore this more in the future)docs/v1/manual.mddocs/v2/, with a.keepfile (this pattern is commonly used with rails projects)