Core Concepts

Configuration

Configure Vishnuraj pr Documentation to meet your team's needs

Basic Setup

Get started with basic configuration options for your documentation space.

Create Workspace

Set up your initial workspace and organization settings.

curl -X POST https://api.vishnurajpr.com/workspaces \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{"name":"My Company Docs","plan":"free"}'

Configure Permissions

Define roles and permissions for your team members.

const permissions = {
  admin: ['read', 'write', 'delete', 'manage'],
  editor: ['read', 'write'],
  viewer: ['read']
};
fetch('/api/permissions', {
  method: 'PUT',
  headers: { 'Authorization': `Bearer ${token}` },
  body: JSON.stringify(permissions)
});

Set Up Branding

Customize the look and feel of your documentation.

{
  "branding": {
    "logo": "https://example.com/logo.png",
    "colors": {
      "primary": "#3B82F6",
      "secondary": "#64748B"
    }
  }
}

Configuration changes take effect immediately, but some settings may require a page refresh.

Advanced Configuration

Explore advanced options to customize your documentation experience.

Set up webhooks for real-time notifications.

curl -X POST https://api.vishnurajpr.com/webhooks \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{"url":"https://yourapp.com/webhook","events":["document.updated"]}'

const webhook = {
  url: 'https://yourapp.com/webhook',
  events: ['document.created', 'document.updated'],
  secret: 'your-webhook-secret'
};
fetch('/api/webhooks', {
  method: 'POST',
  headers: { 'Authorization': `Bearer ${token}` },
  body: JSON.stringify(webhook)
}).then(res => res.json()).then(data => console.log('Webhook created:', data));

Environment Variables

Configure your application using environment variables.

Variable	Description	Required
`VISHNURAJ_API_KEY`	Your API key	Yes
`VISHNURAJ_BASE_URL`	API base URL	No
`VISHNURAJ_TIMEOUT`	Request timeout in seconds	No

Store sensitive variables securely using your platform's secret management system.

Troubleshooting Configuration

Common configuration issues and solutions.

Permission denied: Check your user role and workspace permissions
Webhook not firing: Verify the webhook URL and event types
Integration failing: Ensure third-party credentials are correct

# Debug configuration
curl -X GET https://api.vishnurajpr.com/config/debug \
  -H "Authorization: Bearer YOUR_TOKEN"

Was this page helpful?

Built with Documentation.AI

Last updated today