CircleCI Docs Static Site: Technical Documentation

Welcome to the comprehensive technical documentation for the CircleCI Docs Static Site project. This documentation is designed to help developers, content authors, and contributors understand the project's architecture, workflow, and best practices.

Table of Contents

• Overview
• Documentation Files
• Getting Started
• Contributing

Overview

The CircleCI Docs Static Site is a documentation platform built using Antora, a static site generator designed for multi-repository documentation. This project combines:

• Component-based architecture: Organized documentation into logical sections
• AsciiDoc content: Powerful markup language for technical documentation
• Custom UI: Tailored presentation with modern web technologies
• Automated build pipeline: Streamlined development and deployment process

Documentation Files

This technical documentation consists of several specialized files:

Getting Started

For Contributors

1. Set up your environment:

   git clone https://github.com/circleci/circleci-docs.git
   cd circleci-docs
   npm ci
   

2. Make sure you've cloned server-4 branches (Server Administration Docs)*

   npm run fetch-server-branches

3. Start the development server:

   npm run start:dev
   

4. Test the setup (optional):

   ./scripts/test-setup.sh
   

For API Documentation

This project includes integrated API documentation built with Redocly:

1. Test the integration:

   ./scripts/test-setup.sh
   

2. Build API docs:

   npm run build:api-docs
   

3. Customize API docs:

   • Replace api-spec.yaml with your OpenAPI specification
   • Edit redocly.yaml for styling and configuration
   • See API_DOCS_INTEGRATION.md for details

Technical Reference

3. Review the architecture:
   • Read ARCHITECTURE.md for system design
   • Review DEVELOPMENT.md for development workflow
   • Consult TECHNICAL_REFERENCE.md for detailed specs

For Content Authors

1. Understand the content organization:

   • Read CONTENT_AUTHORING.md for guidelines
   • Review existing content for examples and patterns

2. Set up your environment:

   • Follow the developer setup instructions
   • Start the development server to preview changes

3. Create or edit content:

   • Follow the AsciiDoc formatting guidelines
   • Use the appropriate component structure
   • Test your content locally

Contributing

We welcome contributions to both the documentation content and the technical infrastructure. To contribute:

1. Review CONTRIBUTING.md for guidelines
2. Set up your development environment
3. Create a branch for your changes
4. Submit a pull request