From 81c3fd01489de9abfb2b6487e3d36c032215a1b4 Mon Sep 17 00:00:00 2001 From: Ian Clanton-Thuon Date: Fri, 8 Apr 2022 19:09:12 -0700 Subject: [PATCH] Update references to main branch on the tsdoc repo. --- pages/contributing/github.md | 10 +++++----- pages/intro/roadmap.md | 4 ++-- pages/intro/using_tsdoc.md | 2 +- pages/packages/eslint-plugin-tsdoc.md | 2 +- pages/packages/tsdoc-config.md | 4 ++-- pages/packages/tsdoc.md | 6 +++--- pages/spec/overview.md | 6 +++--- pages/spec/standardization_groups.md | 2 +- 8 files changed, 18 insertions(+), 18 deletions(-) diff --git a/pages/contributing/github.md b/pages/contributing/github.md index 71bce72..3181b33 100644 --- a/pages/contributing/github.md +++ b/pages/contributing/github.md @@ -9,14 +9,14 @@ The TSDoc projects are developed in a single GitHub monorepo: [https://github.com/microsoft/tsdoc](https://github.com/microsoft/tsdoc) The package folders are: -- [/tsdoc](https://github.com/microsoft/tsdoc/tree/master/tsdoc): the **@microsoft/tsdoc** package -- [/tsdoc-config](https://github.com/microsoft/tsdoc/tree/master/tsdoc-config): the **@microsoft/tsdoc-config** package -- [/eslint-plugin](https://github.com/microsoft/tsdoc/tree/master/eslint-plugin): the **eslint-plugin-tsdoc** package +- [/tsdoc](https://github.com/microsoft/tsdoc/tree/main/tsdoc): the **@microsoft/tsdoc** package +- [/tsdoc-config](https://github.com/microsoft/tsdoc/tree/main/tsdoc-config): the **@microsoft/tsdoc-config** package +- [/eslint-plugin](https://github.com/microsoft/tsdoc/tree/main/eslint-plugin): the **eslint-plugin-tsdoc** package Supplementary project folders are: -- [/api-demo](https://github.com/microsoft/tsdoc/tree/master/api-demo): a code sample showing how to use +- [/api-demo](https://github.com/microsoft/tsdoc/tree/main/api-demo): a code sample showing how to use the **@microsoft/tsdoc** library -- [/playground](https://github.com/microsoft/tsdoc/tree/master/playground): the [TSDoc Playground](/play) web application +- [/playground](https://github.com/microsoft/tsdoc/tree/main/playground): the [TSDoc Playground](/play) web application The `tsdoc.org` website is hosted in this Github repo: diff --git a/pages/intro/roadmap.md b/pages/intro/roadmap.md index e1fb895..d00dccc 100644 --- a/pages/intro/roadmap.md +++ b/pages/intro/roadmap.md @@ -25,8 +25,8 @@ a particular feature will get implemented. That said, here’s some feature area future investments: - Collect all the design specifications from the GitHub "RFC" issues and document them on the website -- Finish integrating the [new declaration reference syntax](https://github.com/microsoft/tsdoc/tree/master/tsdoc/src/beta) +- Finish integrating the [new declaration reference syntax](https://github.com/microsoft/tsdoc/tree/main/tsdoc/src/beta) and deprecate the old syntax - Expand the parser to support a much broader set of CommonMark syntax elements -- Expand the capabilities of the [tsdoc.json](https://github.com/microsoft/tsdoc/tree/master/tsdoc-config) config file +- Expand the capabilities of the [tsdoc.json](https://github.com/microsoft/tsdoc/tree/main/tsdoc-config) config file - Write up a formal grammar specification diff --git a/pages/intro/using_tsdoc.md b/pages/intro/using_tsdoc.md index ebdb66c..8ecd653 100644 --- a/pages/intro/using_tsdoc.md +++ b/pages/intro/using_tsdoc.md @@ -12,6 +12,6 @@ Even if you have not enabled a documentation tool yet for your project, adopting πŸ‘‰ **To see how your comments would be rendered** by a compatible documentation tool, try pasting your `/** */` comment into the [TSDoc Playground](/play)! -πŸ‘‰ **Implementing a tool that needs to parse doc comments?** The [@microsoft/tsdoc](https://www.npmjs.com/package/@microsoft/tsdoc) package provides a professional quality parser. The [api-demo](https://github.com/microsoft/tsdoc/tree/master/api-demo) folder contains sample code showing how to invoke the parser. +πŸ‘‰ **Implementing a tool that needs to parse doc comments?** The [@microsoft/tsdoc](https://www.npmjs.com/package/@microsoft/tsdoc) package provides a professional quality parser. The [api-demo](https://github.com/microsoft/tsdoc/tree/main/api-demo) folder contains sample code showing how to invoke the parser. πŸ‘‰ **Have an idea for an improvement?** We're using [GitHub issues](https://github.com/Microsoft/tsdoc/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to discuss the TSDoc specification, library design, and project roadmap. diff --git a/pages/packages/eslint-plugin-tsdoc.md b/pages/packages/eslint-plugin-tsdoc.md index d6f7e59..e684649 100644 --- a/pages/packages/eslint-plugin-tsdoc.md +++ b/pages/packages/eslint-plugin-tsdoc.md @@ -5,7 +5,7 @@ navigation_source: docs_nav --- [NPM package](https://www.npmjs.com/package/eslint-plugin-tsdoc)
-[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/master/eslint-plugin/CHANGELOG.md) +[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/main/eslint-plugin/CHANGELOG.md) This ESLint plugin provides a rule for validating that TypeScript doc comments conform to the [TSDoc specification](https://github.com/microsoft/tsdoc). diff --git a/pages/packages/tsdoc-config.md b/pages/packages/tsdoc-config.md index fe47d19..9c8c2ea 100644 --- a/pages/packages/tsdoc-config.md +++ b/pages/packages/tsdoc-config.md @@ -5,7 +5,7 @@ navigation_source: docs_nav --- [NPM package](https://www.npmjs.com/package/@microsoft/tsdoc-config)
-[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/master/tsdoc-config/CHANGELOG.md) +[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/main/tsdoc-config/CHANGELOG.md) The **@microsoft/tsdoc-config** package is an optional add-on for loading the **tsdoc.json** file format that enables @@ -22,7 +22,7 @@ until it finds a folder containing **tsconfig.json** or **package.json**, and th The **tsdoc.json** file conforms to the [tsdoc.schema.json]( https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json) JSON schema. It defines tags using similar fields as the -[TSDocTagDefinition](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/configuration/TSDocTagDefinition.ts) +[TSDocTagDefinition](https://github.com/microsoft/tsdoc/blob/main/tsdoc/src/configuration/TSDocTagDefinition.ts) API used by `TSDocParser` from **@microsoft/tsdoc**. Here's a simple example: diff --git a/pages/packages/tsdoc.md b/pages/packages/tsdoc.md index bc4d321..4c782e4 100644 --- a/pages/packages/tsdoc.md +++ b/pages/packages/tsdoc.md @@ -5,7 +5,7 @@ navigation_source: docs_nav --- [NPM package](https://www.npmjs.com/package/@microsoft/tsdoc)
-[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/master/tsdoc/CHANGELOG.md) +[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/main/tsdoc/CHANGELOG.md) The **@microsoft/tsdoc** package is the reference implementation of a parser for the TSDoc syntax. You cannot use it directly. It is an engine component intended to be incorporated into @@ -141,7 +141,7 @@ console.log(isApiInternal(input)); The library provides a number of other nice features: - It tracks source code coordinates for every input token. This enables precise error messages - for every token, and can be used to implement [syntax highlighting](https://github.com/microsoft/tsdoc/blob/master/playground/src/SyntaxStyler/DocNodeSyntaxStyler.ts). + for every token, and can be used to implement [syntax highlighting](https://github.com/microsoft/tsdoc/blob/main/playground/src/SyntaxStyler/DocNodeSyntaxStyler.ts). - It provides an Abstract Syntax Tree that makes it easy to [render rich text](https://github.com/microsoft/tsdoc/blob/26c4bab8efb04bc5d1619585e1f071bcc10cf16a/playground/src/DocHtmlView.tsx#L140) @@ -155,6 +155,6 @@ The library provides a number of other nice features: ## Invoking the TSDoc parser -The [api-demo folder](https://github.com/microsoft/tsdoc/tree/master/api-demo) provides a more complete example. +The [api-demo folder](https://github.com/microsoft/tsdoc/tree/main/api-demo) provides a more complete example. It also contains an "advanced" example, illustrating how to interface TSDoc with the parse tree returned by the TypeScript compiler engine. diff --git a/pages/spec/overview.md b/pages/spec/overview.md index 146d647..b71b7ca 100644 --- a/pages/spec/overview.md +++ b/pages/spec/overview.md @@ -17,12 +17,12 @@ implementation of a parser, and many syntax details are explained in the code co The **"old"** syntax for declaration references is detailed in this technical note: -[/spec/code-snippets/DeclarationReferences.ts](https://github.com/microsoft/tsdoc/blob/master/spec/code-snippets/DeclarationReferences.ts) +[/spec/code-snippets/DeclarationReferences.ts](https://github.com/microsoft/tsdoc/blob/main/spec/code-snippets/DeclarationReferences.ts) The **"new"** syntax for declaration references is described in this grammar: -[/tsdoc/src/beta/DeclarationReference.grammarkdown](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/beta/DeclarationReference.grammarkdown) +[/tsdoc/src/beta/DeclarationReference.grammarkdown](https://github.com/microsoft/tsdoc/blob/main/tsdoc/src/beta/DeclarationReference.grammarkdown) Examples of the new syntax can be found in the -[DeclarationReference.test.ts](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/beta/__tests__/DeclarationReference.test.ts) +[DeclarationReference.test.ts](https://github.com/microsoft/tsdoc/blob/main/tsdoc/src/beta/__tests__/DeclarationReference.test.ts) file. diff --git a/pages/spec/standardization_groups.md b/pages/spec/standardization_groups.md index 3c50235..140c1ba 100644 --- a/pages/spec/standardization_groups.md +++ b/pages/spec/standardization_groups.md @@ -6,7 +6,7 @@ navigation_source: docs_nav Three "standardization groups" are used to classify the standard TSDoc tags, according to the the level of support expected from compatible documentation tools. They correspond to the -[Standardization enum](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/details/Standardization.ts) +[Standardization enum](https://github.com/microsoft/tsdoc/blob/main/tsdoc/src/details/Standardization.ts) in the parser API.