chore(repo): Add docs about Typedoc + output fixes #5442
Merged
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.
Description
This mainly adds a README to the
.typedoc
folder and instructions to the CONTRIBUTING file. It's definitely not exhaustive and if you're curious about more information / you'd like me to add some more, please let me know. Happy to braindump more information.Other than that, in this PR I marked some things as
@internal
or@inline
so that they are not generated at all / as separate things.Fixes ECO-527
Checklist
pnpm test
runs as expected.pnpm build
runs as expected.Type of change