microsoft / microsoft/tsdoc

TSDoc 1.0 Release Planning/Work

Open
#309 2 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the TSDoc 1.0 roadmap and the linked Zulip discussion to understand the release scope and history. The issue identifies declaration references, bold and italics, and matching opening and closing HTML elements as independent parser areas; done means addressing the selected blocker and validating it against the 1.0 plan.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.