docnerd/config.example.yaml at main · beamable/docnerd · 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# docNerd configuration
# Copy to config.yaml and fill in values (or use environment variables)

# Source repository (where PRs are opened)
source_repo:
  owner: your-org
  name: your-source-repo
  # token: set via GITHUB_TOKEN or SOURCE_REPO_TOKEN env var

# Target documentation repository (MkDocs + Mike)
target_repo:
  owner: your-org
  name: your-docs-repo
  # token: set via TARGET_REPO_TOKEN env var (needs write access)

# Claude / Anthropic
llm:
  api_key: ""  # set via ANTHROPIC_API_KEY env var
  model: claude-sonnet-4-20250514
  # base_url: optional, for custom endpoint

# Path to rules directory (relative to project root or absolute)
rules_path: rules

# Comment trigger
trigger_phrase: "@docNerd, doc for"

# Branch naming for docNerd's working branches
branch_prefix: docnerd

# Docs fetcher (when loading existing docs from target repo)
docs_fetcher:
  # Paths are ranked by PR search terms before capping (not raw A–Z) so cli/deploy docs load.
  # max_files is a deprecated alias for max_priority_files.
  max_priority_files: 100
  max_content_per_file: 6000
  # Additional paths get short excerpts only (full inventory still listed in the system prompt)
  max_secondary_files: 200
  secondary_content_per_file: 2000

# Doc generation behavior
# allow_new_files: true = may create new files when no existing doc fits (default)
# allow_new_files: false = only edit existing docs, never create new files
allow_new_files: true

# doc_generation.mode: phased (default) = PR narrative file, then one Claude call per .md file,
#   adequacy check, optional expansion, then reviewer loop on proposed edits only.
#   legacy = single monolithic writer + full-tree review (old behavior).
doc_generation:
  mode: phased
  phased:
    # Keep at 1 unless Anthropic has raised your concurrent-connection limit (429 otherwise).
    max_parallel_doc_calls: 1
    # Optional throttle between per-doc calls when max_parallel_doc_calls is 1
    # delay_seconds_between_doc_calls: 0.5
    per_doc_max_content_chars: 80000
    api_max_retries: 8
    api_retry_base_delay_seconds: 2.5
    # DOCNERD_CACHE.yml: per-page summaries + blob SHA; gate skips unlikely pages before full edit
    docnerd_cache:
      enabled: true
      path: DOCNERD_CACHE.yml
      use_description_gate: true
      gate_max_tokens: 256
      describe_max_tokens: 2048
      max_chars_for_describe: 48000
      delay_seconds_between_cache_calls: 0
      # Extra GitHub API + stricter invalidation (usually unnecessary; content_sha suffices)
      check_commit_after_description: false
    narrative_max_tokens: 8192
    adequacy_max_tokens: 4096
    expansion_max_tokens: 24000

# Reviewer agent: after initial docs, a second pass reviews for public-user clarity;
# the writer refines until satisfied or limits hit.
doc_review_loop:
  enabled: true
  max_wall_seconds: 600 # 10 minutes total wall clock for the whole loop
  max_rounds: 5 # max reviewer+refine cycles

# PR analysis - fetch full file content from base branch (not just diff)
pr_analysis:
  fetch_full_contents: true
  max_files: 30
  max_content_per_file: 12000