Skip to content

Conversation

Copy link

Copilot AI commented Sep 8, 2025

This PR adds test scripts to demonstrate access to the MD fragments documentation system. The implementation includes two utility scripts that print and validate the available MD fragments topics.

What was added

scripts/print-md-fragments-topics.js - A user-friendly script that displays all available MD fragments topics in a formatted layout:

MD Fragments Topics Available:
==============================

📚 How to Give Up
   Running out of time? Here's what to do

📚 How to Finish a Session
   Information about mandatory tasks to do at the end of a session
...
Total topics available: 8

scripts/md-fragments-topics-test.js - A validation test script that:

  • Lists all topics in numbered format with descriptions
  • Validates that all expected topics are present
  • Returns PASS/FAIL status for automated testing
  • Can be imported as a module for other tests

Available Topics

The scripts successfully identify and display these 8 documentation topics:

  1. How to Give Up - Running out of time? Here's what to do
  2. How to Finish a Session - Information about mandatory tasks to do at the end of a session
  3. How to Debug - Tips and tricks for how to debug code
  4. Compiler Tests - How to write, run, and manage tests related to core tsc functionality
  5. Compiler Tests > Dealing with Baselines - How to work with baseline-based tests
  6. Compiler Tests > Creating - How to create a new compiler test, and its syntax
  7. Compiler Tests > Test File Syntax - Syntax for how to set options and filenames in compiler baseline tests
  8. Fourslash Testing - Fourslash is our testing system for language service functionality

Usage

# Display formatted topic list
node scripts/print-md-fragments-topics.js

# Run validation test
node scripts/md-fragments-topics-test.js

Both scripts run successfully and all validation checks pass. The implementation demonstrates that the MD fragments documentation system is accessible and can be programmatically queried.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

RyanCavanaugh and others added 10 commits June 27, 2025 12:11
...including mandatory workflow, time constraints, and best practices.
...including mandatory tasks, debugging tips, and common commands.
...to the copilot instructions for better guidance.
...including how to give up, common commands, session finishing tasks, debugging tips, compiler tests, and fourslash testing.
...in knip.jsonc to exclude it from dependency checks.
Copilot AI changed the title [WIP] Test run only: print back the list of MD fragments topics Add MD fragments topics test scripts Sep 8, 2025
Copilot AI requested a review from RyanCavanaugh September 8, 2025 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants