Repository navigation
Expand file tree
/
Copy path.matlatl.yml
More file actions
56 lines (51 loc) · 2.93 KB
/
Copy path.matlatl.yml
File metadata and controls
56 lines (51 loc) · 2.93 KB
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
# matlatl configuration. https://github.com/stacklok/matlatl
version: 1
# Docusaurus resolves /... links inside user-docs from its content root.
contentRoots:
- "user-docs"
# MDX imports do not create navigational edges for matlatl. The underscore
# directory keeps these source fragments out of the Docusaurus docs tree;
# declaring them roots prevents strict structural checks from treating them as
# standalone orphaned pages.
roots:
- "user-docs/_partials/*.mdx"
# Exclude git-ignored working files from the corpus (matlatl v0.0.8):
# union the repo's effective git ignore set (tracked + nested .gitignore rules,
# .git/info/exclude, global excludes) with .matlatlignore. Local-only files
# (HANDOFF.md, CLAUDE.local.md, agent scratch notes) are otherwise scanned as
# corpus documents and flagged as orphans, which (a) fails `check --strict`
# locally on files a clean CI checkout never sees. No-op when the scan root is
# not a git work tree.
respectGitignore: true
# Promote the graduated structure findings (under-linked, dead-end) from Info to
# Warning, so they FAIL `matlatl check --strict` (the CI docs gate) instead of
# only being reported. This makes documentation connectivity an enforced
# invariant: a doc that nothing links to (under-linked) or that links nowhere onward
# (dead-end) breaks the build.
#
# inboundThreshold is set to 1 — the gate floor, NOT matlatl's default of 3. The
# default (3) is a strong *discoverability* heuristic that suits the human-facing
# report but is wrong as a hard gate here: legitimate leaf docs (the emit-excluded
# .claude/skills reference payloads, a generated artifact reached from one index)
# have one or two genuine inbound links and demanding three would force link-spam.
# Threshold 1 enforces the real invariant — every doc with outbound links is
# reachable by at least one link, and nothing is a dead-end — without gaming. NOTE:
# `matlatl: orphan-intentional` front matter only exempts ORPHAN/UNREACHABLE
# findings, NOT under-linked/dead-end, so the gate must be satisfied by real links.
structureFindingsSeverity: warning
inboundThreshold: 1
# emitExclude keeps these docs IN the graph — still scanned, link-checked,
# ranked, and gated by `check` — but hides them from generated documentation
# surfaces. It has zero effect on the check exit code or graph.json.
#
# Used here for the skills under .claude/skills/: they are dev tooling, not
# product documentation, so they stay off the navigation surface, but some link
# into docs/ and those links must stay verified.
emitExclude:
# Skill definitions (SKILL.md + their references/). Note: SKILL.md files are
# auto-detected reachability roots, so matlatl emits an informational config
# notice that an excluded root won't render on the consumption surfaces —
# that's expected and does not affect reachability or the gate.
- ".claude/skills/"
# Site authoring guidance is linked from user-docs, but is not product docs.
- "website/AGENTS.md"