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

Typedoc site seems not updated #9524

Open
3 tasks done
kenrick95 opened this issue Nov 10, 2023 · 5 comments
Open
3 tasks done

Typedoc site seems not updated #9524

kenrick95 opened this issue Nov 10, 2023 · 5 comments
Labels
Package: browser Issues related to the Sentry Browser SDK Type: Bug

Comments

@kenrick95
Copy link

Is there an existing issue for this?

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/browser

SDK Version

N/A

Framework Version

No response

Link to Sentry event

No response

SDK Setup

No response

Steps to Reproduce

  1. Visit https://getsentry.github.io/sentry-javascript/index.html
  2. While the latest version is already v7.80.0, I see that all over the place, the typedoc still mention v7.57.0

Expected Result

Typedoc is updated with the latest version

Actual Result

Screenshot 2023-11-10 at 15 48 56

@getsantry getsantry bot moved this to Waiting for: Product Owner in GitHub Issues with 👀 Nov 10, 2023
@github-actions github-actions bot added the Package: browser Issues related to the Sentry Browser SDK label Nov 10, 2023
@Lms24
Copy link
Member

Lms24 commented Nov 10, 2023

Hi @kenrick95 thanks for writing in! You're right, the type docs aren't actively updated. I think the 7.57.0 release only is in there because we made a quick attempt to bring them back a while ago and had to abandon it (used to be a v6 or early v7 version beforehand).

I'm gonna keep the issue because it's valid feedback but since a few months our team has been in "firefighting" mode and we're completely booked with p0 tasks. So I can't promise any ETA on this being resolved.

Is there something particular you were missing in our docs that made you look up the type docs?

To everyone reading: PRs are welcome if you wanna take a stab at fixing this!

@kenrick95
Copy link
Author

I see, nothing in particular, just happen to stumble upon the typedoc site earlier today.

Do you have any pointers how to fix this? I assume it is being hosted in "gh-pages" branch, so perhaps a Github Actions workflow is needed to do this automatically?

@getsantry getsantry bot moved this to Waiting for: Product Owner in GitHub Issues with 👀 Nov 10, 2023
@Lms24
Copy link
Member

Lms24 commented Nov 10, 2023

I think a good starting point is probably #8440 in which Abhi attempted to bring them back.

@AbhiPrasad
Copy link
Member

hey yeah I just didn't get the time to take care of this - PRs are welcome if you would like to help!

@mydea
Copy link
Member

mydea commented Nov 11, 2024

Maybe we should just remove the gh-pages and close this - I'd say it's better to have nothing published than an outdated/incorrect typedoc? 😬 Since we don't really have any concrete plans to update/fix this in the near future..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Package: browser Issues related to the Sentry Browser SDK Type: Bug
Projects
Status: No status
Development

No branches or pull requests

4 participants