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.

Sign up for GitHub

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

Jump to bottom

[Bug] Docs link appears to be broken #149

Closed
2 tasks done
freddieb opened this issue Oct 31, 2023 · 1 comment
Closed
2 tasks done

[Bug] Docs link appears to be broken #149

freddieb opened this issue Oct 31, 2023 · 1 comment
Assignees
@austin-denoble
Labels
bug Something isn't working

Comments

@freddieb
Copy link

Is this a new bug?

  • I believe this is a new bug
  • I have searched the existing issues, and I could not find an existing issue for this bug

Current Behavior

The 'Reference Documentation' button does not appear to work (get a Github pages 404) https://www.npmjs.com/package/@pinecone-database/pinecone#pinecone-nodejs-client-----

Expected Behavior

Link works

Steps To Reproduce

  1. Go to the NPM package page
    1. Click the link 'Reference Documentation'

Relevant log output

No response

Environment

- **OS**:
- **Language version**:
- **Pinecone client version**:

Additional Context

No response
@freddieb freddieb added the bug Something isn't working label Oct 31, 2023
@austin-denoble austin-denoble mentioned this issue Oct 31, 2023
Merged
2 tasks
@austin-denoble austin-denoble self-assigned this Oct 31, 2023
@austin-denoble
Copy link
Contributor

austin-denoble commented Oct 31, 2023 •
edited
Loading

Thanks for reporting. We recently updated the domain that hosts our reference documentation, and missed updating the README link. I've opened a PR to get that cleaned up: #150.

In the meantime, you can find the reference docs at this address: https://sdk.pinecone.io/typescript/classes/Pinecone.html

austin-denoble added a commit that referenced this issue Oct 31, 2023
@austin-denoble
Update README Reference Documentation link (#150)
4ccf45d 
## Problem
An issue was filed calling out the broken **Reference Documentation**
link in the `README.md` file:
#149

We recently updated our domain for hosting client reference docs:
#146

## Solution

Update the link to the new location and match previous routing:
https://sdk.pinecone.io/typescript/classes/Pinecone.html

## Type of Change
- [X] Bug fix (non-breaking change which fixes an issue)
- [X] Non-code change (docs, etc)

## Test Plan
Check that the **Reference Documentation** link in `README.md` navigates
to the correct page.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@austin-denoble austin-denoble

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@freddieb @austin-denoble