refactor(content-blog): clean up type definitions; in-code documentation #6922
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
This is part of a bigger effort to make our codebase more approachable, both for internal types and the types exposed to end-users. For example, since we have JSDoc in the config file, the user can now use intellisense to see the documentation for any option:
It also means we can achieve #6649 without actually writing much Markdown. We may investigate migrating our API documentation to Typedoc later, so we don't maintain two sets of documentation (JSDoc and Markdown)
Have you read the Contributing Guidelines on pull requests?
Yes