mirror of
https://github.com/vladmandic/automatic
synced 2026-09-18 16:54:33 +02:00
update skills and wiki
Co-authored-by: Copilot <copilot@github.com> Signed-off-by: vladmandic <mandic00@live.com>
This commit is contained in:
@@ -19,7 +19,8 @@ Read markdown files in the `wiki/` folder, fix markdown syntax issues, and impro
|
||||
|
||||
Primary scope:
|
||||
|
||||
- Files under `wiki/**/*.md`
|
||||
- Files under `wiki/**/*.md`, but can be used on any markdown file in the repo if specified by the user
|
||||
- Skip any files starting with `_` (e.g. `_footer.md`) or non-markdown files (e.g. `LICENSE.txt`) to avoid unintended edits to non-doc files or templates.
|
||||
|
||||
Baseline actions:
|
||||
|
||||
@@ -53,6 +54,14 @@ Expanded actions (when user allows full pass):
|
||||
|
||||
## Procedure
|
||||
|
||||
## Validation Tool
|
||||
|
||||
Use the repo-local validation script before and after doc edits when possible:
|
||||
|
||||
- `test/check-docs` to validate all wiki markdown files
|
||||
- `test/check-docs wiki/File.md` to validate one or more specific files
|
||||
- `test/check-docs --fix wiki/File.md` only when a safe markdownlint auto-fix is appropriate
|
||||
|
||||
### 1. Confirm Target And Depth
|
||||
|
||||
Extract from user prompt:
|
||||
@@ -67,6 +76,7 @@ If targets are missing, ask for paths before editing.
|
||||
|
||||
For each target file:
|
||||
|
||||
- If the scope is broad or unclear, run `test/check-docs` first to establish the current markdown baseline.
|
||||
- Scan for syntax/rendering issues
|
||||
- Identify readability pain points (dense blocks, weak headings, mixed terminology)
|
||||
- Note risky sections where edits may alter meaning
|
||||
@@ -129,6 +139,7 @@ For fenced code blocks:
|
||||
|
||||
Validate each edited file against this checklist:
|
||||
|
||||
- `test/check-docs` or `test/check-docs <file...>` passes for the affected scope
|
||||
- markdown renders correctly
|
||||
- heading hierarchy is logical
|
||||
- code fences include language where known
|
||||
|
||||
Executable
+35
@@ -0,0 +1,35 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
cd "$ROOT_DIR"
|
||||
|
||||
if [[ "${1:-}" == "-h" || "${1:-}" == "--help" ]]; then
|
||||
cat <<'EOF'
|
||||
Usage:
|
||||
test/check-docs
|
||||
test/check-docs wiki/File.md wiki/Other.md
|
||||
test/check-docs --fix wiki/File.md
|
||||
|
||||
Runs markdownlint-cli2 against wiki markdown files.
|
||||
If no files are provided, all wiki markdown files are checked except files whose
|
||||
basename starts with an underscore.
|
||||
|
||||
Any arguments are passed through to markdownlint-cli2.
|
||||
EOF
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if [[ $# -eq 0 ]]; then
|
||||
mapfile -t targets < <(rg --files wiki | rg '\.md$' | rg -v '(^|/)_')
|
||||
else
|
||||
targets=("$@")
|
||||
fi
|
||||
|
||||
if [[ ${#targets[@]} -eq 0 ]]; then
|
||||
echo "No markdown files matched." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
exec npx --yes markdownlint-cli2 "${targets[@]}"
|
||||
+1
-1
Submodule wiki updated: 90887c3356...9508720eb9
Reference in New Issue
Block a user