Skip to content

Conversation

continue[bot]
Copy link
Contributor

@continue continue bot commented Oct 2, 2025

Overview

This PR implements reusable Mintlify snippets for cookbook setup sections to maintain consistency and enable easy updates across all cookbook guides.

Changes

New Snippets Created

  • cookbook-what-youll-learn.mdx - Standard "What You'll Learn" section with variable support
  • cookbook-prerequisites.mdx - Standard "Prerequisites" section with customizable lists
  • cookbook-workflow-options.mdx - Quick Start vs Manual setup workflow options
  • cookbook-setup-steps.mdx - Common Continue CLI setup steps
  • cookbook-manual-setup.mdx - Manual configuration steps template

Supporting Files

  • cookbook-learning-points.mdx - Variable-driven learning points list
  • cookbook-prerequisite-list.mdx - Variable-driven prerequisites list
  • validate-snippets.js - Validation script for snippet usage
  • README.md - Comprehensive documentation for snippet usage
  • variables/posthog-cookbook-vars.json - Example variable definitions

Test Implementation

  • Updated PostHog cookbook to use new snippets as proof of concept
  • Demonstrated variable substitution working correctly

Benefits

  1. Consistency - All cookbooks now use identical structure and wording
  2. Maintainability - Update once in snippets, changes apply everywhere
  3. Flexibility - Variables allow customization while maintaining structure
  4. Efficiency - No more copy/pasting setup sections between cookbooks

Usage Example

<Snippet file="cookbook-what-youll-learn.mdx" variables={{
  "tool_name": "PostHog MCP",
  "primary_function": "query analytics, errors, and feature flags",
  "skill_1": "Analyze user behavior patterns with AI",
  "skill_2": "Automatically create GitHub issues using GitHub CLI",
  "skill_3": "Set up continuous monitoring with GitHub Actions"
}} />

Validation

  • ✅ Validation script confirms snippets are properly structured
  • ✅ PostHog cookbook successfully uses snippets with variables
  • ✅ All variables are properly documented in README
  • ✅ Follows Mintlify guidelines for reusable snippets

Next Steps

Other cookbooks can now be updated to use these snippets:

  • Netlify MCP cookbook
  • Snyk MCP cookbook
  • DLT MCP cookbook
  • Future cookbook guides

Following Mintlify guidelines: https://www.mintlify.com/docs/create/reusable-snippets


This agent session was co-authored by tingwai and Continue.


Summary by cubic

Adds reusable Mintlify snippets for cookbook setup sections and updates the PostHog guide to use them, improving consistency and speeding up maintenance. Addresses Linear CON-4169 by standardizing cookbook setup content across cookbooks.

  • New Features

    • Added core snippets: What You’ll Learn, Prerequisites, Setup Steps, Workflow Options, Manual Setup.
    • Added variable components for learning points and prerequisites.
    • Added validate-snippets.js to list variables and confirm snippet usage in cookbooks.
    • Added README with usage and variable docs.
    • Implemented a PostHog cookbook example using the new snippets and variables.
  • Migration

    • Replace manual sections in cookbooks with includes.
    • Define variables per cookbook (see variables/posthog-cookbook-vars.json as a template).
    • Run validate-snippets.js to verify snippet usage and variables resolve.
    • Optionally adopt the Workflow Options snippet for Quick Start vs Manual setup.

- Add cookbook-what-youll-learn.mdx with variables for learning points
- Add cookbook-prerequisites.mdx with customizable prerequisite lists
- Add cookbook-workflow-options.mdx for quick start vs manual setup
- Add cookbook-setup-steps.mdx for Continue CLI setup
- Add cookbook-manual-setup.mdx for manual configuration steps
- Add validation script and comprehensive README
- Update PostHog cookbook to use new snippets as test implementation

This enables easy maintenance of cookbook setup sections across all guides.
Following Mintlify guidelines for reusable snippets and variables.

Generated with [Continue](https://continue.dev)

Co-Authored-By: Continue <[email protected]>
Co-authored-by: Username <[email protected]>
@BekahHW BekahHW changed the title Create reusable Mintlify snippets for cookbook setup sections Feat: Create reusable Mintlify snippets for cookbook setup sections Oct 2, 2025
@bdougie bdougie changed the title Feat: Create reusable Mintlify snippets for cookbook setup sections docs: Create reusable Mintlify snippets for cookbook setup sections Oct 2, 2025
@TyDunn TyDunn closed this Oct 6, 2025
@github-project-automation github-project-automation bot moved this from Todo to Done in Issues and PRs Oct 6, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Oct 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants