circleci-docs/agent-docs.config.yml at main · circleci/circleci-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# AF Docs Configuration
# Documentation: https://afdocs.dev/ci-integration

# Production documentation URL
url: https://circleci.com/docs/

# Optional: Specify which checks to run (uncomment to customize)
# By default, all 23 checks will run
# checks:
#   - llms-txt-exists
#   - llms-txt-valid
#   - llms-txt-size
#   - sitemap-exists
#   - sitemap-valid
#   - robots-txt-exists
#   - meta-tags-present
#   - structured-data
#   - heading-hierarchy
#   - link-text-quality
#   - alt-text-present
#   - code-snippets-clear
#   - navigation-structure
#   - search-functionality
#   - mobile-responsive
#   - page-load-time
#   - content-readability
#   - version-info
#   - last-updated
#   - breadcrumbs
#   - table-of-contents
#   - cross-references
#   - api-documentation

# Configuration options
options:
  # Use deterministic sampling for consistent weekly monitoring
  # Default is random, but deterministic allows better trend tracking
  # Use default for now but consider using deterministic for better trend tracking in future
  # samplingStrategy: deterministic

  # Exclude legacy server versions from coverage checks
  # Only /latest/ server documentation should be included in llms.txt
  coverageExclusions:
    - '/server-admin/server-4.2/**'
    - '/server-admin/server-4.3/**'
    - '/server-admin/server-4.4/**'
    - '/server-admin/server-4.5/**'
    - '/server-admin/server-4.6/**'
    - '/server-admin/server-4.7/**'
    - '/server-admin/server-4.8/**'

  # Exclude <img> tags from markdown-content-parity check
  # Our markdown converter automatically strips out img tags
  parityExclusions:
    - img

# Optional: Test specific pages with tags
# pages:
#   - url: https://circleci.com/docs/getting-started/
#     tags: [onboarding]
#   - url: https://circleci.com/docs/configuration-reference/
#     tags: [reference, important]