tsdocs SKILL.md skillC

tsdocs from chrisreddington/flight-school is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add chrisreddington/flight-school/tsdocs@git:20260523.deb156a

Pins git:20260523.deb156a in mdr.lock. Pin the fingerprint instead.

Audit grade
C, 14 of 17 checks passed
Kind
SKILL.md skill
Repository
chrisreddington/flight-school
Path
.github/skills/tsdocs/SKILL.md
Versions recorded
1
Latest version
git:20260523.deb156a, committed May 23, 2026
Size
13,617 bytes
Repository stars
30
License
MIT

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# TSDocs Skill

## Overview

This skill is the practical companion to the project's TSDoc rules. It shows what good TSDoc looks like in *this* codebase, points at real files to mine for patterns, and calls out common gaps so you can fix them when you touch a file.

**TSDoc vs JSDoc.** TSDoc is a documentation comment standard maintained by Microsoft, designed specifically for TypeScript. JSDoc predates it and was built for JavaScript — its tags often double as type annotations (`@param {string}`), which is redundant when the language already has types. TSDoc drops type-in-comment annotations and standardizes the tag grammar so tools (API Extractor, VS Code, ESLint plugins) parse the same comments the same way. **This project uses TSDoc** so editor hovers, future generated docs, and lint rules all agree.

**Why TSDoc matters here.** It powers three concrete things:

1. **Editor hovers** — every `@param`, `@returns`, `@throws` you write shows up when a teammate hovers over the call site in VS Code.
2. **Generated docs** — if/when we publish API reference pages, TSDoc is what gets extracted.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add chrisreddington/flight-school/tsdocs@sha256:54ab2abea951304e

The line at the top of this page pins the label git:20260523.deb156a, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_k42ouoanp7cqcwfu.svg)](https://markdownregistry.com/a/art_k42ouoanp7cqcwfu)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on May 23, 2026.

versioncommittedcommitsizeaudit
git:20260523.deb156a latest2026-05-23 deb156a 13,617 BC view

Audit of the latest version

C  14 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • fail: Frontmatter block present
  • fail: Frontmatter declares a name
  • fail: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (13617 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Starting a new one? Use a template for SKILL.md on mdpantry, which passes every one of these checks and says what to change in it.

Source

GitHub

chrisreddington/flight-school · 30 stars · license MIT · pushed 2026-10-17 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_k42ouoanp7cqcwfu
GET https://markdownregistry.com/api/v1/resolve?ref=chrisreddington/flight-school/tsdocs
GET https://markdownregistry.com/api/v1/blob/54ab2abea951304e11394926284b4be8859ec6f1f1507e20047c62626e9dc2bf

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from chrisreddington/flight-school

aspire-debugging SKILL.md skill
chrisreddington/flight-school · .github/skills/aspire-debugging/SKILL.md · Debug Flight School with Aspire Dashboard telemetry and Aspire MCP tools.
git:20260521.85a9cc1 · audit A · 30 stars
copilot-sdk-worker-only SKILL.md skill
chrisreddington/flight-school · .github/skills/copilot-sdk-worker-only/SKILL.md · Use whenever you are writing, reviewing, or refactoring any code that touches the GitHub Copilot SDK…
git:20260524.78cd692 · audit A · 30 stars
copilot-sdk SKILL.md skill
chrisreddington/flight-school · .github/skills/copilot-sdk/SKILL.md
git:20260524.78cd692 · audit C · 30 stars
doc-currency SKILL.md skill
chrisreddington/flight-school · .github/skills/doc-currency/SKILL.md · Use BEFORE declaring any non-trivial task complete. Sweeps the documentation that exists to describe the area you just…
git:20260525.c3cfa7a · audit A · 30 stars
dry SKILL.md skill
chrisreddington/flight-school · .github/skills/dry/SKILL.md
git:20260523.deb156a · audit C · 30 stars
how-to-design-like-github SKILL.md skill
chrisreddington/flight-school · .github/skills/how-to-design-like-github/SKILL.md · Use whenever you are designing, building, or reviewing UI in Flight School and want it to look and feel like a…
git:20260529.8c3254a · audit A · 30 stars
opentelemetry SKILL.md skill
chrisreddington/flight-school · .github/skills/opentelemetry/SKILL.md · Instrument Flight School with OpenTelemetry traces, metrics, and logs in line with the OTel GenAI semantic conventions…
git:20260529.a59623a · audit A · 30 stars
panel-review SKILL.md skill
chrisreddington/flight-school · .github/skills/panel-review/SKILL.md · Use whenever you are planning, executing, or finishing any non-trivial architectural change — multi-file refactors…
git:20260601.3abef12 · audit A · 30 stars
readable-code SKILL.md skill
chrisreddington/flight-school · .github/skills/readable-code/SKILL.md · Use whenever you are writing, reviewing, or refactoring TypeScript/TSX in this repo. Enforces the project's readability…
git:20260524.32ea246 · audit A · 30 stars
solid SKILL.md skill
chrisreddington/flight-school · .github/skills/solid/SKILL.md
git:20260523.deb156a · audit C · 30 stars
tdd SKILL.md skill
chrisreddington/flight-school · .github/skills/tdd/SKILL.md
git:20260524.78cd692 · audit C · 30 stars
tests-that-respect-boundaries SKILL.md skill
chrisreddington/flight-school · .github/skills/tests-that-respect-boundaries/SKILL.md · Use whenever you are writing, reviewing, or refactoring tests in this repo. Enforces the project's contract that tests…
git:20260526.7b314d2 · audit B · 30 stars

Every file in chrisreddington/flight-school

Browse by kind, by grade C, or by owner.