Add a package-specific documentation section #863
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
Inspired by https://github.com/celestiaorg/celestia-node#package-specific-documentation Addresses #842 (review) We can keep the share docs in Godoc form or move them back to README.md form because both will render in https://pkg.go.dev/github.com/celestiaorg/celestia-app/pkg/shares
rach-id
reviewed
Oct 13, 2022
There was a problem hiding this comment.
What do you think of the following tool ?
https://github.com/posener/goreadme
Might make sense to add it and make our lives even easier
Good find. Looks like a cool tool and on cursory investigation, I think we may be able to use it to generate package specific READMEs by overriding:
Created #870 |
rach-id
approved these changes
Oct 13, 2022
rach-id
pushed a commit
to rach-id/celestia-app
that referenced
this pull request
Nov 16, 2022
Inspired by https://github.com/celestiaorg/celestia-node#package-specific-documentation Addresses celestiaorg#842 (review) We can keep the share docs in Godoc form or move them back to README.md form because both will render in https://pkg.go.dev/github.com/celestiaorg/celestia-app/pkg/shares
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.
Inspired by https://github.com/celestiaorg/celestia-node#package-specific-documentation
Addresses #842 (review)
We can keep the share docs in Godoc form or move them back to README.md form because both will render in https://pkg.go.dev/github.com/celestiaorg/celestia-app/pkg/shares