Overview

Think of Guides as your API's instruction manual. This is where you'll transform complex concepts into clear, engaging documentation that helps developers succeed with your API. Whether you're documenting authentication flows or walking through common use cases, we've got the tools to make your docs shine.

🎨 Creating and Managing Guides

Writing great documentation shouldn't feel like rocket science. Our editing experience brings documentation creation right to your hub, where you can:

• Create and organize documentation in real-time
• Preview changes exactly as your users will see them
• Collaborate with your team seamlessly
• Publish updates with confidence

Your docs live where you do – right in the hub. Spot something that needs updating? Just click, edit, and publish. No more context-switching between different interfaces!

With our MDX-powered editor, you can take your guides beyond static text:

• Add interactive code samples that developers can test right in your docs
• Create expandable sections for complex topics
• Insert diagrams and visualizations to explain complex concepts
• Build custom components to showcase your API's unique features

📚 Structuring Your Documentation

Great documentation tells a story. Some developers will want to dive straight into code samples, while others might need more background. Our structure lets you cater to both by helping you organize your content in a way that makes sense for your API:

• Categories: Group related content together
• Pages: Create standalone guides or multi-page tutorials
• Sections: Break down complex topics into digestible chunks
• Custom Navigation: Design a flow that guides developers through your API journey

✨ Best Practices for Writing Guides

The most effective guides combine clear explanations with practical examples. Here are some tips to make your guides more helpful:

• Start with the why: Explain the purpose and benefits before diving into implementation
• Use progressive disclosure: Begin with basic concepts before introducing advanced topics
• Show, don't just tell: Include code examples that developers can copy and adapt
• Consider different learning styles: Some developers learn by reading, others by doing
• Keep it scannable: Use headings, lists, and callouts to make information easy to find
• Update regularly: Keep your guides in sync with your API as it evolves

🔄 Reusing Content Across Guides

📘

Business Tier Feature

Reusable Content is available on our Enterprise plan. Want to level up your documentation? Reach out to our team to learn more about Enterprise features that can supercharge your docs!

Why write the same explanation twice? With reusable content blocks, you can:

• Create consistent explanations for common concepts
• Update information in one place and see it change everywhere
• Maintain a unified voice across your entire documentation
• Save time and reduce the risk of outdated information

🚀 Next Steps

Ready to create guides that your developers will actually want to read? Here's how to get started:

1. Create your first guide with our intuitive editor
2. Organize your content into a logical structure
3. Add interactive elements with MDX components
4. Set up reusable content for consistency across your docs

Need inspiration? Check out our guide writing templates or browse example guides from other APIs.