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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# SPDX-FileCopyrightText: 2026 PythonWoods <dev@pythonwoods.dev>
# SPDX-License-Identifier: Apache-2.0
# zenzic.toml — Standalone configuration for the Zenzic Core repository.
#
# This is a "Prose-only Maintenance" config: it scans root-level Markdown
# files (README, CONTRIBUTING, CHANGELOG, SECURITY, etc.) without any
# nav-awareness.  The full documentation site lives in the separate
# zenzic-doc repository, which uses engine = "docusaurus".

docs_dir = "."

# Exclude code, tests, examples, and build artefacts — only prose matters here.
# Directories like .venv, .git, .nox, __pycache__, etc. are already excluded
# by Zenzic's system defaults.  The entries below cover project-specific dirs.
excluded_dirs = [
    "src",
    "tests",
    "examples",
    "mutants",
    "scripts",
    "assets",
    "drafts",
    "Draft",
    "LICENSES",
    ".redteam",
    "arch",
    "configuration",
    "usage",
    "dist",
    "build",
    "temp",
]

# Root-level project files that are not documentation assets.
# With docs_dir = ".", every non-Markdown file would be flagged as an
# unreferenced asset.  These globs suppress that noise.
excluded_assets = [
    "*.toml",
    "*.lock",
    "*.yml",
    "*.yaml",
    "*.json",
    "*.xml",
    "*.ini",
    "*.cfg",
    "*.cff",
    "*.txt",
    "justfile",
    "noxfile.py",
    "LICENSE",
    "NOTICE",
    ".gitignore",
    ".coverage",
]

# Historical changelogs contain example secrets and deprecated syntax
# snippets that would trigger Shield and Snippet false positives.
excluded_file_patterns = ["CHANGELOG*.md"]

# Cross-repo documentation links and files excluded from scanning that are
# still referenced as link targets.  Suppress FILE_NOT_FOUND for them.
excluded_build_artifacts = [
    "docs/configuration/*.md",
    "docs/adr/*.md",
    "CHANGELOG*.md",
    ".github/workflows/*.yml",
]

# External URLs excluded from the broken-link check.
# The GitHub repository URL returns 429 in CI (rate-limited).
# The settings/tokens URL requires authentication (403 for bots).
# zenzic.dev is excluded entirely: the site is not yet deployed and all
# sub-paths time out (>10 s).  Re-enable once DNS propagation is complete.
excluded_external_urls = [
    "https://github.com/PythonWoods/zenzic",
    "https://github.com/settings/tokens",
    "https://zenzic.dev/",
]

# Pattern matching disabled: the README and CHANGELOG describe placeholder
# patterns as examples, which would cause false positives.
placeholder_patterns = []

snippet_min_lines = 1
placeholder_max_words = 50

[build_context]
engine = "standalone"

# ── Internal dogfood rules ────────────────────────────────────────────────────
# Minimal rule set for root-level prose files.

[[custom_rules]]
id       = "ZZ-NOCLICKHERE"
pattern  = "(?i)\\bclick here\\b|\\bclicca qui\\b"
message  = "Avoid generic link text. Use a meaningful description for accessibility."
severity = "error"