Cole-Greer opened a new pull request, #3375: URL: https://github.com/apache/tinkerpop/pull/3375
While reviewing the recently published 4.0.0-SNAPSHOT docs, it was noticed that almost all classes were excluded from the docs (see first image). <img width="2035" height="889" alt="image" src="https://github.com/user-attachments/assets/e1ccefe7-67e5-47a0-9b36-58971c2920cd"; /> The root cause of this issue was the migration to TypeScript, as JSDoc does not support `.ts` files, only `.js` files. There are 2 possible solutions to this problem, the first is to point JSDoc at the compiled `.js` files, and restoring the old docs format. The solution this PR adopted is replacing JSDoc with TypeDoc to generate documentation directly from `.ts` files, including type information. The first commit in this PR changes the build infrastructure to typedoc, while the second commit replaces old JSDoc-style comments in `gremlin-javascript` with the new Typedoc format. The docs continue to generate html files to `gremlin-js/gremlin-javascript/doc/` so this is a drop-in replacement to the broader docs build and deployment infrastructure. The new docs format is visually quite different from JSDoc, but is annotated with richer type data and also includes a helpful search function which is lacking in JSDoc. See the below images for reference: <img width="1758" height="1128" alt="image" src="https://github.com/user-attachments/assets/777e6189-19aa-486b-98e1-953f8ba26c9c"; /> <img width="1831" height="1295" alt="image" src="https://github.com/user-attachments/assets/e4304abb-e590-423d-8c11-7c8d3f2e8403"; /> <img width="1762" height="1244" alt="image" src="https://github.com/user-attachments/assets/0a1fa456-9f7f-4b59-b3ae-4195fec96a85"; /> VOTE +1 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
