This repository has been archived by the owner on Apr 19, 2024. It is now read-only.
Docs cleanup #375
Merged
Docs cleanup #375
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
Also remove "Others/suggestions" template because it doesn't add much value
- Fix issues link - Do not instruct people to apply a specific label to their issue since people without write or triage access cannot assign labels - Avoid repeating questions from the Bug report template - Simplify the rest of the instructions so it's easier to read
AlecAivazis
reviewed
Sep 16, 2021
| @@ -56,39 +56,12 @@ func main() { | |||
| } | |||
| ``` | |||
|
|
|||
| ## Table of Contents | |||
There was a problem hiding this comment.
For a long readme like this, i think its important to have a table of contents
There was a problem hiding this comment.
As explained in the commit message, GitHub auto-generates a table of contents for every Markdown document
So does pkg.go.dev:
There was a problem hiding this comment.
whoa! that's fancy. Sounds good to me!
AlecAivazis
approved these changes
Sep 16, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.