Skip to content

Commit 5658ee8

Browse files
readme updates
1 parent 1602d79 commit 5658ee8

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

examples/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
- [Adding examples](#adding-examples)
2323
- [End to end testing](#end-to-end-testing)
2424
- [Using code examples in the docs site](#using-code-examples-in-the-docs-site)
25+
- [Generating Tutorials and Metadata](#generating-tutorials-and-metadata)
26+
2527
<hr />
2628

2729
# Introduction
@@ -414,11 +416,11 @@ Once your `docs` PR is merged, Netlify should automatically build and deploy the
414416

415417
If this happens you will need to log into the Netlify site, check the error and retry the build. Usually this will fix the deployment issue, otherwise follow up on the error message shown by Netlify.
416418

417-
## Generating Tutorials and Metadata for the example apps with AI
419+
# Generating Tutorials and Metadata
418420

419-
Whenever you add a new example app, or update an existing example app, you can use the prompts in the `prompt.txt` files in each `examples/product` folder to generate the tutorials and metadata for the example apps.
421+
Whenever you add a new example app, or update an existing example app, you can use the prompts in the `prompt.txt` files in each `examples/product` folder to generate the tutorials and metadata for the example apps using Cursor AI.
420422

421-
These AI generated tutorials and metadata files are piped through to the docs site in the CI/CD pipeline, where they are used to display the example apps and their code walkthroughs. If you don't follow these steps, your example app will not be displayed on the docs site.
423+
These AI generated tutorials and metadata files are then piped through to the docs site in the CI/CD pipeline, where they are used to display the example apps and their code walkthroughs. If you don't follow these steps, your example app will not be displayed on the docs site.
422424

423425
There is a single prompt for each product as we expect the examples to follow a similar structure and format, therefore the prompt to generate the tutorials and metadata is the same for each product. You can specify which example app you want the prompt to generate the tutorials and metadata for by adding the app name to the prompt as shown below.
424426

0 commit comments

Comments
 (0)