Getting Started
Step-by-step guide to setting up your first Annu Gulati Documentation project
Quick Setup
Get up and running with Annu Gulati Documentation in just a few minutes. Follow these steps to create your first project and start documenting.
Sign Up
Visit the platform and create your account. Use your professional email for team collaboration features.
Verify Email
Check your email for a verification link and confirm your account.
Create Project
Click "New Project" and give it a descriptive name like "API Documentation" or "User Guides".
Configure Settings
Set up project permissions, choose your theme, and configure basic settings.
Project Configuration
Once your project is created, customize it to match your team's workflow and branding needs.
Configure your project's name, description, and visibility settings. Choose whether to make it public or private.
Invite team members and assign roles. Set up read/write permissions for different user groups.
Connect with external tools like GitHub, Slack, or your CI/CD pipeline for automated documentation updates.
// Example API integration
const docClient = new AnnuGulatiDocs({
apiKey: 'your-api-key',
projectId: 'project-123'
});
await docClient.createDocument({
title: 'API Reference',
content: '# API Documentation
This is the API docs...',
tags: ['api', 'reference']
});
from annu_gulati_docs import Client
client = Client(api_key='your-api-key', project_id='project-123')
client.create_document(
title='API Reference',
content='# API Documentation
This is the API docs...',
tags=['api', 'reference']
)
Content Creation
Start adding content to your project using our intuitive editor. Support for Markdown and MDX makes it easy to create rich documentation.
Publishing Your Docs
When your content is ready, publish it for your team to access. Choose between draft and published states for controlled releases.
Review Content
Preview your documentation to ensure formatting and links work correctly.
Set Permissions
Configure who can view and edit your published documentation.
Publish
Click publish to make your documentation live.
Last updated today