Snippet library
Keep Markdown documentation beside a snippet
Snippet Text is the content you insert. Snippet Document is the context that helps you choose and use that content correctly.
Updated August 3, 2026
Add documentation
Select a snippet
Open Main and choose the snippet you want to explain.
Open Snippet Document
Switch from Snippet Text to the Snippet Document tab in the editor.
Write the notes in Markdown
Add headings, lists, code, links, prerequisites, or warnings. Save the updated snippet.
What belongs in a snippet document
- The situation in which the snippet should be used.
- Values that must be checked before insertion.
- Command prerequisites, rollback steps, or expected output.
- Links to project references and policies.
- Examples that distinguish similar replies or templates.
# Production deployment
## Before running
- Confirm the release tag
- Check the status page
- Keep the rollback command ready
## Owner
Release engineering
## Before running
- Confirm the release tag
- Check the status page
- Keep the rollback command ready
## Owner
Release engineering
Keep inserted text clean
Documentation is not added to the expanded result. This lets you preserve operational context without pasting internal notes into an email, terminal, or customer response.
Best use
Attach documentation when a reusable block can be technically correct but contextually wrong. The note helps prevent choosing it in the wrong situation.