search

Chevrotain / chevrotain

Parser Building Toolkit for JavaScript
https://chevrotain.io
Apache License 2.0
2.44k stars 200 forks source link

Many links in tutorial do not work #1874

Closed maral closed 1 year ago

maral commented 1 year ago

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 commented 1 year ago

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

bd82 commented 1 year ago

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

bd82 commented 1 year ago

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 commented 1 year ago

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

bd82 commented 1 year ago

https://github.com/TypeStrong/typedoc/issues/2092

bd82 commented 1 year ago

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...