TSDoc 1.0 Release Planning/Work

[Nezteb]

trafficstars

This is a placeholder issue for working on a 1.0 release of TSDoc, partially outlined here: https://tsdoc.org/pages/intro/roadmap/

After talking with @octogonz, he summarized:

As far as blockers for finalizing the spec ("1.0" release), how I see it the really important issues are:

1. Finish integrating the new declaration reference syntax
2. Improve the parser to support bold and italics
3. Improve the parser to support matching of opening/closing HTML elements

These are the breaking changes that would be most disruptive for projects that adopted the old syntax.

Pete and I had a video call to summarize some of the history and challenges of TSDoc syntax and reference implementations. The three items above aren't necessarily ordered; all three items can be independently worked on.

Although I am not an expert in parsers, I'm hoping to find time to work on item 2 for bold and italics in order to familiarize myself with the existing parser. If I can accomplish that, I'd like to take a shot at the new reference syntax.

There is also a stream topic in the Rush Stack Zulip chat room.

[Nezteb]

Full disclosure, a couple months after making this issue I became an engineering manager and did a lot less development. Then I eventually left that company (which used full-stack TypeScript) and went to work full time with Elixir/Phoenix, so I totally dropped the ball on this. 😅

[octogonz]

Happens to the best of us! 😊