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

Update typedoc.json configurations and type exports #119

Merged
merged 4 commits into from
Sep 14, 2023

Conversation

austin-denoble
Copy link
Contributor

@austin-denoble austin-denoble commented Sep 14, 2023

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

  • Update 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.
  • Update the {@link PineconeArgumentError} doc strings to {@link Errors.PineconeArgumentError to properly pull in the references.
  • Export missing types: IndexName, CollectionName, DeleteManyByVectorIdOptions, DeleteManyByFilterOptions, and QueryShared.

Type of Change

  • Infrastructure change (CI configs, etc)

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:
Screenshot 2023-09-14 at 4 39 59 PM

@austin-denoble austin-denoble force-pushed the adenoble/typedoc-config-cleanup branch from 6a894f3 to 3673f24 Compare September 14, 2023 20:42
@austin-denoble austin-denoble marked this pull request as ready for review September 14, 2023 20:44
src/data/index.ts Outdated Show resolved Hide resolved
@austin-denoble austin-denoble merged commit cd964fc into main Sep 14, 2023
@austin-denoble austin-denoble deleted the adenoble/typedoc-config-cleanup branch September 14, 2023 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants