Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve TypeDoc Configuration and Include Latest Documentation #26

Merged
merged 2 commits into from
May 23, 2024

Conversation

erdimaden
Copy link
Contributor

What changed? Why?

Updating TypeDoc command to expand entry points and add latest generated documentation

Qualified Impact

@@ -16,7 +16,7 @@
"clean": "rm -rf dist/*",
"build": "tsc",
"prepack": "tsc",
"docs": "typedoc"
"docs": "typedoc --entryPoints ./src --entryPointStrategy expand"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we ignore the OpenAPI generated objects?

Copy link
Contributor

@John-peterson-coinbase John-peterson-coinbase left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not Blocking for now: Should we remove the OpenAPI generated objects from the docs before we release?

@erdimaden erdimaden merged commit 5dbd3b9 into master May 23, 2024
6 checks passed
@erdimaden
Copy link
Contributor Author

@John-peterson-coinbase good question! let's discuss this on slack

@erdimaden erdimaden deleted the feat/typedoc-updates-and-command-update branch June 21, 2024 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants