Circleci Docs

Theme by Circleci

|

Updated: 23 May 2025

|

809 Stars

Documentation for CircleCI.

Categories

Overview:

The CircleCI Documentation is a public repository for the CircleCI Docs, a static website generated by Jekyll. It serves as the main source of documentation for CircleCI, housing various components and branches of documentation. Users can contribute to the documentation by submitting issues or pull requests through the Contributing Guide.

Features:

• Jekyll - Main Site: The main CircleCI documentation site built with Jekyll, containing the majority of the documentation. It integrates other branches of documentation into the site during the build process.
• src-api - API v1.1 and v2 Build Tooling: This component includes the API documentation source for API v1 and v2. API v1 is manually written and compiled to work with Slate, while API v2 is compiled from an OpenAPI spec using Redoc.
• Testing Checklist: A checklist for testing is available within the confluence space to provide more flexibility for users.

Installation:

To contribute to the CircleCI Documentation, follow these steps:

1. Clone the repository:

git clone https://github.com/circleci/docs.git
cd docs

2. Make changes to the desired component:

• For Jekyll - Main Site:
  • Modify the markdown files in the relevant folders.
• For src-api - API v1.1 and v2 Build Tooling:
  • API v1: Go to src-api/source/includes and make changes to the markdown files.
  • API v2: Refer to build_api_docs.sh and .circleci/config.yml for the compilation process and make changes accordingly.

3. Ensure compliance with markdown style rules by fixing violations automatically using the automated code review tool.

4. Submit the changes as a pull request following the Contributing Guide.

Summary:

The CircleCI Documentation repository serves as the central hub for CircleCI’s documentation. It consists of the main site built with Jekyll, API documentation for v1 and v2, and a checklist for testing. Users can contribute by making changes to the relevant components and following the Contributing Guide. The documentation is licensed under Creative Commons Attribution-NonCommercial-ShareAlike CC BY-NC-SA and MIT license for different components.