Update typedoc.json configurations and type exports #119
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.
Problem
There are some basic configurations for TypeDoc we can provide to clean up some of the documentation output. There were also a number of warnings being output when running the utility calling out internals that are represented in documentation, but not included due to not being available as an export at the top level.
Solution
typedoc.json
config to exclude/v0/
code paths, include the version number in the output, and hide the generator tagline at the bottom of the page.{@link PineconeArgumentError}
doc strings to{@link Errors.PineconeArgumentError
to properly pull in the references.IndexName
,CollectionName
,DeleteManyByVectorIdOptions
,DeleteManyByFilterOptions
, andQueryShared
.Type of Change
Test Plan
Make sure CI is green.
Validate documentation after it's been built and deployed: https://pinecone-io.github.io/pinecone-ts-client/
The documentation CI step should also still show warnings for some of the
pinecone-generated-ts-fetch
internals, and a few of the index classes. I'm honestly unsure if those should be exported, and exporting them at the top level pulled in additional pieces into warnings so it may need a more thorough pass.Current warnings should look like this: