Skip to content

Ai#342

Open
dragonmantank wants to merge 4 commits into
mainfrom
ai
Open

Ai#342
dragonmantank wants to merge 4 commits into
mainfrom
ai

Conversation

@dragonmantank
Copy link
Copy Markdown
Member

@dragonmantank dragonmantank commented May 16, 2026

A set of changes to help better facilitate a more automated process where we can potentially use AI to help with rough drafts for new tutorials.

This adds a few new NPM commands:

  • npm run create-tutorial - Starts an interactive session to create a new tutorial and configure some basic options like external repos, files to open, etc.
  • npm run edit-tutorial - Initiates everything someone needs to edit a tutorial, like opening a VS Code window, starting the dev server, and opening their browser automatically.

This also ships a new AGENTS.md file that can help LLMS know how to quickly skeleton out a tutorial. For example, the following prompt can be used to generate the steps needed to create a tutorial to show how to send an SMS:

Write a short tutorial using Node and our server SDK to show how to send an SMS. The final step should show the user how to get the Message ID so they can validate that they have completed the tutorial.

This should create the correct files in the correct folder, and the output can be verified by a human.

Expected workflow

  1. User clones this repository
  2. npm install
  3. npm run create-tutorial -- redact_api-node-some_meangingful_name
  4. Configure the tutorial via the prompts
  5. When asked if you want to edit the tutorial, enter Y to open everything that's needed
  6. In the new VS Code window, enter in a prompt to create a tutorial
  7. Verify and edit the resulting files

You can then package and build the tutorial like before using the toolbar.

@dragonmantank dragonmantank requested a review from conshus May 16, 2026 04:36
await generateVSCodeConfig(tutorialName);

// 10. Generate README
const codespaceLink = `https://codespaces.new/${REPO_OWNER}/${REPO_NAME}?devcontainer_path=.devcontainer/${tutorialName}/devcontainer.json`;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const codespaceLink = `https://codespaces.new/${REPO_OWNER}/${REPO_NAME}?devcontainer_path=.devcontainer/${tutorialName}/devcontainer.json`;
const codespaceLink = `https://codespaces.new/${REPO_OWNER}/${REPO_NAME}?devcontainer_path=.devcontainer/${tutorialName}/devcontainer.json`;
const stackblitzLink = `https://stackblitz.com/github/${REPO_OWNER}/${REPO_NAME}/tree/main/sources/${tutorialName}`;

## 🛠️ Edit this Tutorial
Want to make changes to the lesson, add steps, or update starter files?
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](${stackblitzLink})

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](${stackblitzLink})

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