Getting Started

Welcome to AutoDocs! Generate professional documentation for your code in seconds.

🚀 Quick Start

Getting started with AutoDocs is simple. Here's how to generate your first documentation:

              // Your JavaScript code
function calculateTotal(items) {
  return items.reduce((sum, item) => sum + item.price, 0);
}

// Generated documentation:
// ## calculateTotal(items)
// Calculates the total price of all items in the provided array.
// **Parameters:** items - Array of objects with price property
// **Returns:** Number representing total price
// **Example:** calculateTotal([{price: 10}, {price: 20}]) // Returns: 30
            

📋 What You Need

Code to document - Any programming language we support
API key - Get one by signing up for a paid plan
Basic HTTP knowledge - For API integration

🎯 Supported Languages

AutoDocs supports 50+ programming languages including:

JavaScript TypeScript Python Java C++ PHP Ruby Go

Authentication

Learn how to authenticate with the AutoDocs API

🔐 API Keys

All API requests require authentication using your API key. You can find your API key in your account dashboard after signing up.

🔒 Security Note: Keep your API key secure and never share it publicly. Rotate your keys regularly for maximum security.

📨 Request Headers

Include your API key in the Authorization header:

Authorization: Bearer your-api-key-here

🎫 Session Tokens

For web applications, use session tokens for authenticated requests:

              // After login, store the session token
localStorage.setItem('sessionToken', response.session_token);

// Use in API requests
headers: {
  'Authorization': `Bearer ${sessionToken}`
}
            

API Reference

Complete reference for all AutoDocs API endpoints

📝 Generate Documentation

Generate documentation from code text (demo endpoint - no auth required)

POST

/generate-docs

Parameters

Parameter	Type	Required	Description
code	string	Yes	The source code to generate documentation for
language	string	No	Programming language (auto-detected if not provided)

Example Request

              curl -X POST https://techwrite.lozz-riot.workers.dev/generate-docs \
  -H "Content-Type: application/json" \
  -d '{
    "code": "function hello(name) { return \"Hello \" + name; }",
    "language": "javascript"
  }'
            

Example Response

              {
  "documentation": "## hello(name)\n\nReturns a greeting message...\n\n**Parameters:**\n- name: The name to greet\n\n**Returns:** Greeting string\n\n**Example:** hello(\"World\") // Returns: \"Hello World\""
}
            

📁 Generate from Files

Generate documentation from uploaded files (requires authentication)

POST

/generate-files

Authentication

Requires Bearer token authentication

Parameters

Multipart form data with file uploads

Parameter	Type	Description
files	file[]	Code files to analyze (max 10 files, 500KB each)
github	string	GitHub repository URL (alternative to file upload)

Rate Limits

Understanding AutoDocs usage limits and quotas

📊 Tier Limits

Tier	Daily Requests	Monthly Requests	Features
Free	5	150	Demo only
Individual	50	1,500	Copy/paste interface
Pro	500	15,000	API access, GitHub integration
Enterprise	Unlimited	Unlimited	All features, custom integrations

⚡ Rate Limiting

We implement smart rate limiting to prevent abuse:

Per-IP limits: 5 requests per day for demos
Burst protection: Max 10 requests per hour
Automatic blocking: Temporary blocks for excessive usage
Header information: Rate limit headers in responses

🚨 Rate Limit Exceeded: When you exceed limits, you'll receive a 429 status code with retry information.

Code Examples

Practical examples for integrating AutoDocs into your workflow

🚀 JavaScript Integration

Basic Usage

                const API_KEY = 'your-api-key-here';
const API_URL = 'https://techwrite.lozz-riot.workers.dev';

async function generateDocs(code, language = 'javascript') {
  const response = await fetch(`${API_URL}/generate-docs`, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${API_KEY}`
    },
    body: JSON.stringify({ code, language })
  });

  const data = await response.json();
  return data.documentation;
}

// Usage
const code = `
function calculateTotal(items) {
  return items.reduce((sum, item) => sum + item.price, 0);
}
`;

generateDocs(code).then(docs => {
  console.log(docs);
});
              

React Hook

                import { useState } from 'react';

function useAutoDocs() {
  const [loading, setLoading] = useState(false);
  const [error, setError] = useState(null);

  const generateDocs = async (code, language) => {
    setLoading(true);
    setError(null);

    try {
      const response = await fetch('/api/generate-docs', {
        method: 'POST',
        headers: {
          'Content-Type': 'application/json',
        },
        body: JSON.stringify({ code, language }),
      });

      if (!response.ok) {
        throw new Error('Failed to generate documentation');
      }

      const data = await response.json();
      return data.documentation;
    } catch (err) {
      setError(err.message);
      throw err;
    } finally {
      setLoading(false);
    }
  };

  return { generateDocs, loading, error };
}

// Usage in component
function CodeEditor() {
  const { generateDocs, loading } = useAutoDocs();
  const [code, setCode] = useState('');
  const [docs, setDocs] = useState('');

  const handleGenerate = async () => {
    const result = await generateDocs(code, 'javascript');
    setDocs(result);
  };

  return (
    
       setCode(e.target.value)} />
      <button onClick={handleGenerate} disabled={loading}>
        {loading ? 'Generating...' : 'Generate Docs'}
      </button>
      <pre>{docs}</pre>
    </div>
  );
}</code>
              </div>
            </div>

            <div id="python" class="tab-content">
              <h2>🐍 Python Integration</h2>

              <div class="code-block">
                <code>import requests

class AutoDocsClient:
    def __init__(self, api_key):
        self.api_key = api_key
        self.base_url = 'https://techwrite.lozz-riot.workers.dev'

    def generate_docs(self, code, language='python'):
        """Generate documentation for code"""
        response = requests.post(
            f'{self.base_url}/generate-docs',
            json={'code': code, 'language': language},
            headers={'Authorization': f'Bearer {self.api_key}'}
        )

        response.raise_for_status()
        return response.json()['documentation']

# Usage
client = AutoDocsClient('your-api-key')

code = '''
def calculate_total(items):
    """Calculate total price of items"""
    return sum(item['price'] for item in items)
'''

docs = client.generate_docs(code, 'python')
print(docs)</code>
              </div>
            </div>

            <div id="curl" class="tab-content">
              <h2>📡 cURL Examples</h2>

              <h3>Generate Documentation</h3>
              <div class="code-block">
                <code>curl -X POST https://techwrite.lozz-riot.workers.dev/generate-docs \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your-api-key" \
  -d '{
    "code": "function hello(name) { return \"Hello \" + name; }",
    "language": "javascript"
  }'</code>
              </div>

              <h3>Upload Files</h3>
              <div class="code-block">
                <code>curl -X POST https://techwrite.lozz-riot.workers.dev/generate-files \
  -H "Authorization: Bearer your-session-token" \
  -F "files=@main.js" \
  -F "files=@utils.js"</code>
              </div>
            </div>
          </div>

          <!-- Troubleshooting -->
          <div id="troubleshooting" class="docs-content">
            <h1>Troubleshooting</h1>
            <p class="subtitle">Common issues and how to resolve them</p>

            <h2>❌ Common Errors</h2>

            <h3>401 Unauthorized</h3>
            <p><strong>Cause:</strong> Invalid or missing API key</p>
            <p><strong>Solution:</strong> Check your API key is correct and included in the Authorization header</p>

            <h3>429 Rate Limit Exceeded</h3>
            <p><strong>Cause:</strong> Too many requests</p>
            <p><strong>Solution:</strong> Wait for the rate limit to reset or upgrade your plan</p>

            <h3>413 Payload Too Large</h3>
            <p><strong>Cause:</strong> Code file too large</p>
            <p><strong>Solution:</strong> Reduce file size or split into smaller files</p>

            <h3>500 Internal Server Error</h3>
            <p><strong>Cause:</strong> Server-side issue</p>
            <p><strong>Solution:</strong> Try again later or contact support</p>

            <h2>🔍 Debugging Tips</h2>
            <ul>
              <li>Check your API key is valid and not expired</li>
              <li>Verify the request format matches the API documentation</li>
              <li>Test with simple code first before complex files</li>
              <li>Check network connectivity and firewall settings</li>
              <li>Monitor rate limit headers in responses</li>
            </ul>

            <h2>📞 Getting Help</h2>
            <p>If you're still having issues:</p>
            <ul>
              <li><a href="help.html">Check the Help Center</a> for common solutions</li>
              <li><a href="support.html">Contact Support</a> with your issue details</li>
              <li>Include your request ID and error messages</li>
            </ul>
          </div>

          <!-- Changelog -->
          <div id="changelog" class="docs-content">
            <h1>Changelog</h1>
            <p class="subtitle">Latest updates and improvements to AutoDocs</p>

            <h2>📅 Version 1.0.0 - September 2025</h2>
            <ul>
              <li>🚀 Initial public release</li>
              <li>🤖 AI-powered documentation generation</li>
              <li>🌐 Support for 50+ programming languages</li>
              <li>📁 File upload and GitHub integration</li>
              <li>👥 User authentication and tier management</li>
              <li>📊 Admin dashboard and analytics</li>
              <li>🔒 Rate limiting and security features</li>
            </ul>

            <h2>🔮 Upcoming Features</h2>
            <ul>
              <li>🔗 VS Code extension</li>
              <li>📋 Custom documentation templates</li>
              <li>🔄 Webhook integrations</li>
              <li>📈 Advanced analytics</li>
              <li>🎨 Custom branding options</li>
              <li>🔍 Code search and indexing</li>
            </ul>
          </div>

        </div>
      </div>
    </div>
  </section>

  <!-- Footer -->
  <footer class="footer">
    <div class="container">
      <div class="footer-content">
        <div class="footer-brand">
          <h3>AutoDocs</h3>
          <p>AI-Powered Documentation for Developers</p>
        </div>
        <div class="footer-links">
          <div class="footer-column">
            <h4>Product</h4>
            <a href="index.html#features">Features</a>
            <a href="index.html#pricing">Pricing</a>
            <a href="index.html#demo">Demo</a>
          </div>
          <div class="footer-column">
            <h4>Company</h4>
            <a href="about.html">About</a>
            <a href="careers.html">Careers</a>
            <a href="docs.html">Documentation</a>
          </div>
          <div class="footer-column">
            <h4>Support</h4>
            <a href="help.html">Help Center</a>
            <a href="support.html">Contact</a>
            <a href="index.html#admin">Admin</a>
          </div>
        </div>
      </div>
      <div class="footer-bottom">
        <p>© 2025 AutoDocs. All rights reserved.</p>
      </div>
    </div>
  </footer>

  <script>
    // Tab switching functionality
    document.addEventListener('DOMContentLoaded', () => {
      const tabs = document.querySelectorAll('.language-tab');
      const contents = document.querySelectorAll('.tab-content');

      tabs.forEach(tab => {
        tab.addEventListener('click', () => {
          // Remove active class from all tabs
          tabs.forEach(t => t.classList.remove('active'));
          contents.forEach(c => c.classList.remove('active'));

          // Add active class to clicked tab
          tab.classList.add('active');
          const target = document.getElementById(tab.dataset.tab);
          if (target) {
            target.classList.add('active');
          }
        });
      });

      // Smooth scrolling for sidebar links
      document.querySelectorAll('.docs-sidebar a[href^="#"]').forEach(link => {
        link.addEventListener('click', (e) => {
          e.preventDefault();
          const target = document.querySelector(link.getAttribute('href'));
          if (target) {
            target.scrollIntoView({ behavior: 'smooth' });
          }

          // Update active link
          document.querySelectorAll('.docs-sidebar a').forEach(a => a.classList.remove('active'));
          link.classList.add('active');
        });
      });
    });
  </script>
</body>
</html>

Developer
Documentation

📚 Documentation

🔗 Quick Links

Getting Started

🚀 Quick Start

📋 What You Need

🎯 Supported Languages

Authentication

🔐 API Keys

📨 Request Headers

🎫 Session Tokens

API Reference

📝 Generate Documentation

Parameters

Example Request

Example Response

📁 Generate from Files

Authentication

Parameters

Rate Limits

📊 Tier Limits

⚡ Rate Limiting

Code Examples

🚀 JavaScript Integration

Basic Usage

React Hook

DeveloperDocumentation

📚 Documentation

🔗 Quick Links

Getting Started

🚀 Quick Start

📋 What You Need

🎯 Supported Languages

Authentication

🔐 API Keys

📨 Request Headers

🎫 Session Tokens

API Reference

📝 Generate Documentation

Parameters

Example Request

Example Response

📁 Generate from Files

Authentication

Parameters

Rate Limits

📊 Tier Limits

⚡ Rate Limiting

Code Examples

🚀 JavaScript Integration

Basic Usage

React Hook

Developer
Documentation