|
5 | 5 |
|
6 | 6 | REQUIRED = [ |
7 | 7 | 'README.md', |
| 8 | + 'LICENSE', |
8 | 9 | 'CONTRIBUTING.md', |
9 | 10 | 'CODE_OF_CONDUCT.md', |
10 | 11 | 'SECURITY.md', |
|
19 | 20 | '.github/workflows/sync-wiki.yml', |
20 | 21 | 'docs/README.md', |
21 | 22 | 'docs/methodology/quickstart.md', |
| 23 | + 'docs/methodology/glossary.md', |
| 24 | + 'docs/methodology/anti-patterns.md', |
22 | 25 | 'docs/methodology/continuous-improvement-loop.md', |
23 | 26 | 'docs/methodology/definition-of-done.md', |
24 | 27 | 'docs/methodology/maturity-model.md', |
25 | 28 | 'docs/diagrams/README.md', |
| 29 | + 'docs/loops/README.md', |
26 | 30 | 'docs/loops/feature.md', |
27 | 31 | 'docs/loops/bugfix-loop.md', |
| 32 | + 'docs/loops/refactoring.md', |
| 33 | + 'docs/loops/pipeline-repair.md', |
| 34 | + 'docs/loops/iac.md', |
| 35 | + 'docs/loops/security.md', |
| 36 | + 'docs/loops/performance.md', |
28 | 37 | 'docs/loops/release.md', |
29 | 38 | 'docs/verifiers/README.md', |
30 | 39 | 'docs/evaluations/README.md', |
| 40 | + 'docs/local-runner/README.md', |
| 41 | + 'docs/showcase/README.md', |
| 42 | + 'templates/README.md', |
| 43 | + 'templates/project-context.md', |
| 44 | + 'templates/repository-context-template.md', |
| 45 | + 'templates/agent-instructions-template.md', |
| 46 | + 'prompts/README.md', |
31 | 47 | 'prompts/master-system-prompt.md', |
32 | 48 | 'prompts/chatgpt-web.md', |
33 | 49 | 'prompts/continuous-improvement.md', |
34 | 50 | 'wiki/Home.md', |
| 51 | + 'wiki/Architecture-Guide.md', |
35 | 52 | 'wiki/Loops.md', |
36 | 53 | 'wiki/Prompts.md', |
37 | 54 | 'wiki/Releases.md', |
|
40 | 57 |
|
41 | 58 | REQUIRED_MERMAID = [ |
42 | 59 | 'AGENTS.md', |
| 60 | + 'templates/README.md', |
| 61 | + 'docs/methodology/quickstart.md', |
| 62 | + 'docs/methodology/anti-patterns.md', |
43 | 63 | 'docs/methodology/continuous-improvement-loop.md', |
44 | 64 | 'docs/methodology/definition-of-done.md', |
45 | 65 | 'docs/methodology/maturity-model.md', |
46 | 66 | 'docs/diagrams/README.md', |
47 | 67 | 'docs/loops/feature.md', |
48 | 68 | 'docs/loops/release.md', |
| 69 | + 'docs/verifiers/README.md', |
| 70 | + 'docs/evaluations/README.md', |
| 71 | + 'docs/local-runner/README.md', |
49 | 72 | 'wiki/Home.md', |
50 | 73 | ] |
51 | 74 |
|
| 75 | +FORBIDDEN_TEXT = ['TBD', 'TODO', 'FIXME', 'placeholder'] |
52 | 76 | LINK_RE = re.compile(r'\[[^\]]+\]\(([^)]+)\)') |
53 | 77 | SKIP_PREFIXES = ('http://', 'https://', 'mailto:', '#') |
54 | 78 |
|
@@ -78,6 +102,14 @@ def fail(title, items): |
78 | 102 | without_mermaid.append(p) |
79 | 103 | fail('Required diagram docs without Mermaid:', without_mermaid) |
80 | 104 |
|
| 105 | +forbidden_hits = [] |
| 106 | +for md in markdown: |
| 107 | + text = md.read_text(encoding='utf-8') |
| 108 | + for token in FORBIDDEN_TEXT: |
| 109 | + if token.lower() in text.lower(): |
| 110 | + forbidden_hits.append(f'{md.relative_to(ROOT)} contains {token}') |
| 111 | +fail('Forbidden placeholder text found:', forbidden_hits) |
| 112 | + |
81 | 113 | broken_links = [] |
82 | 114 | for md in markdown: |
83 | 115 | text = md.read_text(encoding='utf-8') |
|
0 commit comments