Skip to main content

ARC // OS Documentation

Last Updated: 2026-08-18

Documentation Structure​

This documentation is organized into three main categories:

📖 User Documentation​

Documentation for end users of ARC // OS:

👨‍💻 Developer Documentation​

Documentation for developers working on ARC // OS:

🔌 API Documentation​

📢 Marketing​

Marketing and SEO documentation

📚 Features​

Feature documentation (implementation details)

For Users:

For Developers:

For API Integrations:

Documentation Visibility​

Public (Visible to All)​

  • user/ - All user-facing documentation
  • api/API_DOCUMENTATION.md and api/ENDPOINTS.md - API reference and catalog
  • marketing/ - Marketing content
  • features/ - Feature descriptions

Developer Only (Hidden from Public)​

  • developer/ - All developer-facing documentation

Note: In production, developer documentation should be hidden from the global public, except for the public API and webhook documentation which should remain accessible.

Contributing to Documentation​

When updating documentation:

  1. User docs → Update files in user/
  2. Developer docs → Update files in developer/
  3. API docs → Update api/API_DOCUMENTATION.md and regenerate api/ENDPOINTS.md when routes change
  4. Features → Update files in features/