circleci/circleci-docs

0

/ 100

Documentation65
Engineering98
Health94
HTML8481d ago
Grade a repo

Polished and well engineered. Punching above its star count.

Documentation for CircleCI.

Documentation

65

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

README12pt70

README is present.

Contributing guide5pt88

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

Engineering

98

Reproducibility6pt85

Lockfile present (go.sum). Installs are reproducible.

Tests18pt100

Test files detected (docs/guides/modules/ROOT/images/test).

CI/CD14pt100

CI is configured (.circleci/config.yml).

Linting and formatting5pt100

Formatting enforced (ui/.stylelintrc).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (go.mod).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 1,494
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 848
    Watchers

Responsiveness

  • 2d 21h
    Median issue response
  • <1h
    Median PR merge time
  • 39
    Open issues
Repository files43 root entries
  • .circleci
    Good: CI is configured (.circleci/config.yml).
  • .cursor
  • .github
    Good: Issue or PR templates present.
  • api-v1
  • archive
  • cmd
  • docs
    Good: Test files detected (docs/guides/modules/ROOT/images/test).
    Issue: Build artifacts or local files may be committed (docs/guides/.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • extensions
  • gulp.d
  • internal
  • planning
  • scripts
  • skills
  • styles
  • ui
    Good: Formatting enforced (ui/.stylelintrc).
  • .env.copy
  • .gitignore
    Good: .gitignore present.
  • .htmltest.yml
  • .nvmrc
    Good: Environment pinned via .nvmrc.
  • .vale.ini
  • agent-docs.config.yml
  • AGENTS.md
  • antora-playbook.yml
  • API_DOCS_INTEGRATION.md
  • API_DOCS_LLM_ACCESS_PLAN.md
  • ARCHITECTURE.md
  • CLAUDE.md
  • CONTENT_AUTHORING.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • custom-template.hbs
  • DEVELOPMENT.md
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • gulpfile.js
  • logo.svg
  • openapi-patch.json
  • package-lock.json
  • package.json
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • redocly.yaml
  • renovate.json
  • Taskfile.yml
  • TECHNICAL_REFERENCE.md