|
OpenCoD2-Plus
Call of Duty 2 client & server, rebuilt
|
Functions | |
| md_files (root) | |
| check_file (root, path) | |
| find_problems (root, files) | |
| main () | |
Variables | |
| LINK = re.compile(r'\[[^\]]*\]\(([^)\s]+)\)') | |
| CODE = re.compile(r'`([^`\n]+)`') | |
| tuple | REPO_DIRS = ('src/', 'scripts/', 'test/', 'docs/', 'cmake/', 'mods/', 'third_party/') |
| list | SENSITIVE |
| str | MEMORY = 'docs/ai/PROJECT_MEMORY.md' |
| int | MAX_BULLETS = 3 |
Checks the documentation against the repository.
python3 scripts/check_docs.py [ROOT]
Reads AGENTS.md, the README files and docs/**/*.md (not docs/superpowers,
which is local) and prints one line per problem, as path:line: message:
a relative link to a file that does not exist; a repository path (src/,
scripts/, test/, docs/, cmake/, mods/, third_party/) anywhere in backticks
that does not exist; personal data (a Windows drive path but the
C:\\path\\to\\ placeholder, /home/<name> or /mnt/<drive>, an IPv4 address
but 127.0.0.1 and 0.0.0.0, a CD key or the word codkey); a stage
of docs/ai/PROJECT_MEMORY.md with more than 3 bullets. Paths in the memory and in a
superseded ADR are not checked: they describe what was. Exits with 0 when
there are none.
| check_docs.check_file | ( | root, | |
| path ) |
| check_docs.find_problems | ( | root, | |
| files ) |
| check_docs.main | ( | ) |
| check_docs.md_files | ( | root | ) |
| check_docs.CODE = re.compile(r'`([^`\n]+)`') |
| check_docs.LINK = re.compile(r'\[[^\]]*\]\(([^)\s]+)\)') |
| int check_docs.MAX_BULLETS = 3 |
| str check_docs.MEMORY = 'docs/ai/PROJECT_MEMORY.md' |
| tuple check_docs.REPO_DIRS = ('src/', 'scripts/', 'test/', 'docs/', 'cmake/', 'mods/', 'third_party/') |
| list check_docs.SENSITIVE |