Skip to main content

​
🚀 Quick Start

​
Prerequisites

  1. Node.js (v20 or higher)
  2. Git for version control
  3. GitHub CLI - Install from cli.github.com

​
Setup Steps

  1. Fork and clone the repository 
    # Fork the repository (this will also clone it locally)
gh repo fork gourmand/gobi
cd gobi/docs
  2. Install dependencies 
    npm install
  3. Start the local development server 
    npm run dev
    Your docs will be available at http://localhost:3000

​
💬 Creating Discussions and Issues

Before creating any issues, we ask that you start with a GitHub Discussion. This helps us organize feedback and determine the best path forward.

​
Starting a Discussion

1

Go to GitHub Discussions

Visit the Gobi GitHub Discussions page.
2

Choose the right category

Select the Docs category for documentation improvements, corrections, or suggestions.
3

Provide detailed information

Include the following in your discussion:
  • Clear description of the issue or suggestion
  • Steps to reproduce (if applicable)
  • Expected vs. actual behavior
  • Screenshots or code examples when helpful
  • Your environment (OS, IDE, Gobi version)

​
Issue Escalation Process

Important: All issues should start as discussions. The Gobi team will determine if and when a discussion should be escalated to a GitHub issue.
The Gobi team will review discussions and may:
  • Provide a solution or clarification directly in the discussion
  • Ask for additional information or testing
  • Convert the discussion to an issue if it requires code changes or is a confirmed bug
  • Close the discussion if it’s resolved or not actionable

​
When Discussions Become Issues

A discussion will typically be converted to an issue when:
  • A bug in the documentation is confirmed
  • A new feature or significant documentation change is approved
  • Community consensus supports the proposed change
  • Technical implementation is required

​
🤖 AI-Powered Documentation with Gobi

We strongly encourage using Gobi’s AI assistance to maintain consistency and quality in our documentation. Here are three ways to set this up: The easiest way to get started is using our pre-configured documentation agent:
1

Install the agent from Gobi Hub

Visit the Docs Assistant - Mintlify in the Hub and click “Install” to add it to your Gobi setup. This agent comes pre-configured with all our documentation standards.
Learn more about Gobi Configs in our config documentation.
2

Use the agent

  • Command Line
  • IDE
# Install the Gobi CLI if you haven't already
npm install -g @gourmanddev/cli

# Use the agent from the command line
cn "Create a new guide for using the Gobi CLI with Linear" --config gourmand/docs-mintlify
You can also remix this config to customize it for your specific needs. Learn how to create your own remix in our remix config documentation.

​
Option 2: Create Your Own Custom Agent

If you want more control or customization, you can create your own documentation agent:
1

Create a new config

Follow our config creation guide to set up your own config.
2

Add the Gobi Docs MCP

Install from Gobi Hub: https://hub.gourmand.dev/gourmand/gobi-docs-mcpThis MCP provides context about Gobi’s documentation structure and standards.
3

Add Mintlify formatting rules

Install from Gobi Hub: https://hub.gourmand.dev/mintlify/technical-writing-ruleThis rule ensures proper Mintlify component formatting.
4

Use your custom agent

  • Command Line
  • IDE
# Install the Gobi CLI if you haven't already
npm install -g @gourmanddev/cli

# Use your agent from the command line
cn --config your-org/your-agent-name "Create a new guide for API authentication"

​
📝 Documentation Standards

​
Mintlify Component Guidelines

When using Mintlify components, follow these formatting rules:

​
Cards and Info Boxes

<Card title="Best Practice" icon="lightbulb">

Always include blank lines and proper indentation:

- Use 2-space indentation
- Add blank lines after opening tags
- Format lists as bullet points

</Card>

​
Warning and Note Components

<Warning>

Important information should be formatted clearly:

- Each point on its own line
- Consistent indentation
- Clear, concise language

</Warning>

​
Writing Style

  1. Be concise: Get to the point quickly
  2. Use examples: Show, don’t just tell
  3. Include code blocks: Provide working examples
  4. Add visuals: Screenshots and diagrams help understanding
  5. Test your changes: Ensure all links and code examples work
If you are creating a new guide, please test the steps yourself to ensure accuracy.

​
🔧 Common Tasks

​
Adding a New Guide

  1. Create a new .mdx file in the guides directory
  2. Add frontmatter: 
    ---
title: "Your Guide Title"
description: "Brief description of what this guide covers"
---
  3. Use the Gobi agent to help format your content
  4. Update docs.json to include your new page in the navigation
We have both guides and cookbooks. Use guides for step-by-step instructions and cookbooks for creating agents for the CLI.

​
Updating Existing Documentation

  1. Use the Gobi agent with prompts like:
    • “Update the installation guide with the new npm package”
    • “Add a troubleshooting section for connection issues”
  2. The agent will maintain consistent formatting automatically

​
Adding Code Examples

Use language-specific code blocks: 
```typescript
// Your TypeScript code here
const example = "Hello, Gobi!";
```

​
🐛 Testing Your Changes

  1. Local preview: In the docs directory, run npm run dev and check your changes
  2. Link validation: Ensure all internal and external links work
  3. Format check: Use the Gobi agent to validate Mintlify formatting
  4. Build test: Run npm run build to ensure no build errors

​
📤 Submitting Your Contribution

  1. Create a feature branch 
    git checkout -b docs/your-feature-name
  2. Commit your changes 
    git add .
git commit -m "docs: describe your changes"
  3. Push and create a Pull Request 
    # Push to your fork and create a PR
git push origin docs/your-feature-name
gh pr create --web
The gh pr create command will automatically:
  • Push your branch to your fork
  • Create a pull request to the main repository
  • Allow you to add a title, description, and reference issues
  • Open the PR in your browser if using --web

​
💡 Tips for Success

  • Use the Gobi agent: It knows our documentation standards and will save you time
  • Preview frequently: Check your changes in the local dev server
  • Ask questions: Open an issue or discussion if you need clarification
  • Small PRs are better: Focus on one topic or fix per PR
  • Update examples: Ensure code examples reflect the latest API

​
🆘 Getting Help

  • Start a Discussion: Use GitHub Discussions for documentation issues, suggestions, or questions
  • Gobi agent questions: Check the Gobi Hub page
  • Discord community: Join our Discord for real-time help
  • Existing docs: Review similar pages for formatting examples
Thank you for contributing to Gobi! Your efforts help make our documentation better for everyone. To learn more about contibuting to other parts of the project, check out our main CONTRIBUTING guide 🎉