add documentation contributing instructions #973
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
Gerrit0
approved these changes
Feb 12, 2019
|
@Gerrit0 Technically, the readme is already in the api docs. I think of the 3 different locations like this
I know a lot of people only look at the readme and the website currently doesn't show much information beyond the help input so I'm not sure the best way to keep everything aligned. |
This was referenced Jan 12, 2022
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.
Small section in CONTRIBUTING.md indicating where documentation comes from. Main improvement is that we now explicitly point to TypeStrong/typedoc-site. I also thought it was worthwhile to note our other documentation sources.
While writing this up, I was reminded that options are documented in three different areas with varying completeness. The website now includes the output of
typedoc --helpbut it is unclear what we are putting on the website vs the readme.