zenzic/.zenzic.toml at main · PythonWoods/zenzic · 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
# SPDX-FileCopyrightText: 2026 PythonWoods <dev@pythonwoods.dev>
# SPDX-License-Identifier: Apache-2.0

placeholder_patterns = []

# Precedence: .zenzic.toml is shared baseline; .zenzic.local.toml overrides locally.
# Keep secrets and workstation-only values in .zenzic.local.toml.

# --- PROJECT IDENTITY ---
# [project]
# name = "zenzic" # Used for personalized CLI Governance headers

# --- CORE SETTINGS ---
# ---------------------------------------------------------------------------
# docs_dir
# ---------------------------------------------------------------------------
# The relative path to your documentation root.
#
# BEHAVIOR:
#   - If commented out (default), Zenzic uses Auto-Discovery to find your
#     docs based on the engine (reads docusaurus.config.ts, mkdocs.yml…).
#   - Set to "." to scan the entire repository (L1 system exclusions apply).
#
# DEFAULT: Auto-discovered
#
# docs_dir = "."

strict = true
fail_under = 99
# exit_zero = false
# respect_vcs_ignore = true
# validate_same_page_anchors = true

# External URLs excluded from the broken-link check (applies only with --strict)
excluded_external_urls = [
    # Prevents HTTP 429 (Too Many Requests) rate-limiting from GitHub in CI.
    "https://github.com/PythonWoods/zenzic",
    # Prevents HTTP 403 (Forbidden) since the CI runner is an unauthenticated bot.
    "https://github.com/settings/tokens",
    # GitHub API rate-limits unauthenticated CI runners; prefix covers all remaining github.com links.
    "https://github.com",
    # contributor-covenant.org consistently times out (> 10 s) from CI environments.
    "https://www.contributor-covenant.org/version/2/1/code_of_conduct.html",
    "https://www.contributor-covenant.org",
    # zenzic.dev documentation endpoint is intermittently unavailable in CI network paths.
    "https://zenzic.dev/docs/",
    # Shields.io applies rate-limiting to CI runners (HTTP 429); prefix covers all badge URLs.
    "https://img.shields.io",
]

# Z204 Privacy Gate — terms that must never appear in published docs.
# forbidden_patterns = []

# --- EXCLUSION ZONES (Full bypass — use sparingly) ---
# Paths listed here are INVISIBLE to Zenzic: no findings, no audit trail.
# Prefer [governance.per_file_ignores]

[governance.directory_policies]
"docs/reference/**" = ["Z501"]
"docs/index.md" = ["Z502", "Z501"]
"docs/blog/index.md" = ["Z502"]
"docs/assets/**" = ["Z402", "Z405"]
"docs/blog/**"                    = ["Z601", "Z503", "Z402", "Z101"]
"docs/blog/posts/**"              = ["Z402"]
"docs/explanation/mineral-path.md"    = ["Z601"]
"docs/tutorials/examples/**" = ["Z101", "Z102", "Z103", "Z104", "Z105", "Z107", "Z108", "Z109", "Z201", "Z202", "Z204", "Z301", "Z302", "Z303", "Z402", "Z403", "Z405", "Z501", "Z502", "Z503", "Z505", "Z506", "Z601", "Z603"]
"docs/developers/how-to/contribute/**" = ["Z107"]