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

Many links in tutorial do not work #1874

Closed
maral opened this issue Oct 30, 2022 · 6 comments
Closed

Many links in tutorial do not work #1874

maral opened this issue Oct 30, 2022 · 6 comments

Comments

@maral
Copy link

maral commented Oct 30, 2022

Many links from tutorial or guide lead to the API page of CstParser, however the anchors are not there.

Example 1: https://chevrotain.io/docs/tutorial/step2_parsing.html#introduction

Link: CONSUME

Example 2: https://chevrotain.io/docs/tutorial/step4_fault_tolerance.html#single-token-insertion

Link: canTokenTypeBeInsertedInRecovery

The problem seems to be with the API docs page of CstParser, where should be much more information than there currently is.

@msujew
Copy link
Collaborator

msujew commented Oct 30, 2022

It seems like protected methods in general don't seem to be listed in the API docs. That's weird.

@bd82
Copy link
Member

bd82 commented Nov 2, 2022

Maybe that changed in one of the recent updates to typedocs?

@bd82
Copy link
Member

bd82 commented Nov 2, 2022

From my short inspection it seems like this broke somewhere in the transition to TypeDoc 0.23.x

reverting to 0.22.18 does not seem to be a trivial workaround as the generated website seems partially broken (unsupported typescript version?).

@bd82
Copy link
Member

bd82 commented Nov 2, 2022

Looks like the protected members are now hidden by default by TypeDoc
image

@bd82
Copy link
Member

bd82 commented Nov 3, 2022

TypeStrong/typedoc#2092

@bd82 bd82 closed this as completed in 2a276a7 Nov 4, 2022
@bd82
Copy link
Member

bd82 commented Nov 4, 2022

after releasing 10.4.1 the website (new one for 10.4.1) works as expected for me.
It did seem like I needed to clear cache / hard reload to ensure it works as expected...

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

No branches or pull requests

3 participants