jb/diagram-design
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: consolidate reviewed Diagram Design 2.6.0 release (#134)

Browse Source 
* fix(commands): stop hardcoding the visual-type count

Integrates the final reviewed diff from PR #112.

* docs(high-level): correct effective width checklist

Integrates the final reviewed diff from PR #105.

* fix(commands): quote profile argument hint

Integrates the final reviewed diff from PR #126.

* test(sankey): gate conservation and ribbon geometry

Integrates the final reviewed diff from PR #103.

* feat(tooling): add doctor diagnostics gate

Integrates the final reviewed diff from PR #132.

* feat(scripts): lint diagrams as rendered

Integrates the final reviewed diff from PR #18.

* feat(types): add quantitative polar chart

Integrates the final reviewed diff from PR #101.

* chore(release): consolidate reviewed changes in 2.6.0

Documents every combined gate and synchronizes Claude, Codex, and Factory metadata for the 39-type release.

* fix(doctor): support installed-skill projects

---------

Co-authored-by: mysoniw <soniw1@gmail.com>
Co-authored-by: thang <76550342+thangldw@users.noreply.github.com>
Co-authored-by: YinShaokun <yinshaokun@didiglobal.com>
Co-authored-by: 0xDarkMatter <0xDarkMatter@users.noreply.github.com>
Co-authored-by: Rupam Pal <rupam.pal@euromonitor.com>
Co-authored-by: Yuvraj3905 <yuvraj202001@gmail.com>
This commit is contained in:
Cathryn Lavery
2026-08-20 12:21:43 -07:00
committed by GitHub
co-authored by mysoniw thang YinShaokun 0xDarkMatter Rupam Pal Yuvraj3905
parent 4b573616cb
commit b827385a17
42 changed files with 7090 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/test-verify-docs-sync.py
+175 -18
View File
@@ -1,5 +1,5 @@
#!/usr/bin/env python3
"""Regression tests for docs links and profile-surface verification."""
"""Regression tests for docs links and routing-surface verification."""
from __future__ import annotations
@@ -13,6 +13,37 @@ from pathlib import Path
ROOT = Path(__file__).resolve().parent.parent
VERIFY = ROOT / "scripts" / "verify-docs-sync.py"
HIGH_LEVEL_REFERENCE = """\
## 2. Layout formulas — deterministic geometry
### 2.1 Canvas
```
has_vertical = any(c.vertical for c in chevrons)
right_strip_w = 28 if has_vertical else 0
strip_margin = 8 if has_vertical else 0
effective_w = 1000 - right_strip_w - strip_margin
```
## 7. Reproducibility checklist (the taste gate)
1. Check one.
2. Check two.
3. If a vertical chevron exists, `effective_w = 964`; otherwise, `effective_w = 1000`.
4. Check four.
5. Check five.
6. Check six.
7. Check seven.
8. Check eight.
9. Check nine.
10. Check ten.
11. Check eleven.
12. Check twelve.
13. Check thirteen.
## 8. Anti-patterns
"""
def load_verify_module():
sys.dont_write_bytecode = True
@@ -144,34 +175,71 @@ From a repository checkout, run `python3 <repo-root>/scripts/verify-geometry.py
root = Path(temp_dir) / "repo"
profile_reference = root / "skills/diagram-design/references/profiles.md"
command = root / "commands/profile.md"
prompt = root / "prompts/profile.md"
for path in (profile_reference, command, prompt):
doctor_reference = root / "skills/diagram-design/references/doctor.md"
export_reference = root / "skills/diagram-design/references/export.md"
drawio_reference = root / "skills/diagram-design/references/import-drawio.md"
mermaid_reference = root / "skills/diagram-design/references/import-mermaid.md"
export_command = root / "commands/export-diagram.md"
drawio_command = root / "commands/import-drawio.md"
mermaid_command = root / "commands/import-mermaid.md"
profile_command = root / "commands/profile.md"
doctor_command = root / "commands/doctor.md"
export_prompt = root / "prompts/export-diagram.md"
mermaid_prompt = root / "prompts/import-mermaid.md"
profile_prompt = root / "prompts/profile.md"
doctor_prompt = root / "prompts/doctor.md"
for path in (
profile_reference,
doctor_reference,
export_reference,
drawio_reference,
mermaid_reference,
export_command,
drawio_command,
mermaid_command,
profile_command,
doctor_command,
export_prompt,
mermaid_prompt,
profile_prompt,
doctor_prompt,
):
path.parent.mkdir(parents=True, exist_ok=True)
profile_reference.write_text("# Profiles\n", encoding="utf-8")
command.write_text("Follow references/profiles.md.\n", encoding="utf-8")
prompt.write_text("Follow references/profiles.md.\n", encoding="utf-8")
doctor_reference.write_text("# Doctor\n", encoding="utf-8")
export_reference.write_text("# Export\n", encoding="utf-8")
drawio_reference.write_text("# Draw.io\n", encoding="utf-8")
mermaid_reference.write_text("# Mermaid\n", encoding="utf-8")
export_command.write_text("Follow references/export.md.\n", encoding="utf-8")
drawio_command.write_text("Follow references/import-drawio.md.\n", encoding="utf-8")
mermaid_command.write_text("Follow references/import-mermaid.md.\n", encoding="utf-8")
profile_command.write_text("Follow references/profiles.md.\n", encoding="utf-8")
doctor_command.write_text("Follow references/doctor.md.\n", encoding="utf-8")
export_prompt.write_text("Follow references/export.md.\n", encoding="utf-8")
mermaid_prompt.write_text("Follow references/import-mermaid.md.\n", encoding="utf-8")
profile_prompt.write_text("Follow references/profiles.md.\n", encoding="utf-8")
doctor_prompt.write_text("Follow references/doctor.md.\n", encoding="utf-8")
errors = []
verify.check_profile_surfaces(errors, root)
verify.check_routing_surfaces(errors, root)
if errors:
raise AssertionError(f"valid profile surfaces failed: {errors}")
raise AssertionError(f"valid routing surfaces failed: {errors}")
prompt.unlink()
doctor_prompt.unlink()
errors = []
verify.check_profile_surfaces(errors, root)
expected = "profile surface is missing: prompts/profile.md"
verify.check_routing_surfaces(errors, root)
expected = "routing surface is missing: prompts/doctor.md"
if errors != [expected]:
raise AssertionError(f"missing Pi prompt was not reported: {errors}")
raise AssertionError(f"missing routing prompt was not reported: {errors}")
prompt.write_text("Stale standalone instructions.\n", encoding="utf-8")
doctor_prompt.write_text("Stale standalone instructions.\n", encoding="utf-8")
errors = []
verify.check_profile_surfaces(errors, root)
verify.check_routing_surfaces(errors, root)
expected = (
"profile surface does not route to references/profiles.md: prompts/profile.md"
"routing surface does not route to references/doctor.md: prompts/doctor.md"
)
if errors != [expected]:
raise AssertionError(f"stale Pi prompt was not reported: {errors}")
raise AssertionError(f"stale routing prompt was not reported: {errors}")
factory_manifest = root / ".factory-plugin/plugin.json"
factory_marketplace = root / ".factory-plugin/marketplace.json"
@@ -262,9 +330,98 @@ diagram-design/
if errors != [expected]:
raise AssertionError(f"missing Factory native path was not reported: {errors}")
counted = root / "commands"
counted.mkdir(parents=True, exist_ok=True)
drawio = counted / "import-drawio.md"
mermaid = counted / "import-mermaid.md"
routed = "`--type` forces one of the visual types in SKILL.md \u00a73.\n"
for path in (drawio, mermaid):
path.write_text(routed, encoding="utf-8")
errors = []
verify.check_type_counts(errors, root)
if errors:
raise AssertionError(f"a command pointing at SKILL.md failed: {errors}")
# The stale wording the gate was written for, the same wording wrapped
# across the line the real commands wrap on, and the rewrites a later
# edit would reach for. Each is the only defect in the tree, so the gate
# has to report exactly one error.
for stale in (
"`--type` forces one of the 27.\n",
"`--type` forces one of the\n27 visual types.\n",
"`--type` forces one of 28.\n",
"The skill draws 28 visual types.\n",
"The skill draws 28 supported visual diagram types.\n",
"The skill supports 28 types of visual diagrams.\n",
):
mermaid.write_text(stale, encoding="utf-8")
errors = []
verify.check_type_counts(errors, root)
if len(errors) != 1 or "hardcodes the visual-type count" not in errors[0]:
raise AssertionError(
f"a hardcoded count was not reported for {stale!r}: {errors}"
)
# Counts that are not the visual-type count must pass. A gate that
# rejects "accepts 2 file types" is one contributors route around, and
# both commands already carry unrelated numbers in their flag docs.
for benign in (
"`--type` accepts 2 file types.\n",
"Produces 3 output types.\n",
"`--detail=faithful` allows 24 nodes.\n",
"Reads 2 types of visual file.\n",
):
mermaid.write_text(routed + benign, encoding="utf-8")
errors = []
verify.check_type_counts(errors, root)
if errors:
raise AssertionError(
f"a count unrelated to the taxonomy was rejected for {benign!r}: {errors}"
)
# Restore the routed wording first: leaving a stale count behind lets
# this case pass on the wrong error and never names the missing surface.
mermaid.write_text(routed, encoding="utf-8")
drawio.unlink()
errors = []
verify.check_type_counts(errors, root)
expected = "type-count surface is missing: commands/import-drawio.md"
if errors != [expected]:
raise AssertionError(f"a missing command surface was not reported: {errors}")
errors = []
verify.check_high_level_reference(errors, HIGH_LEVEL_REFERENCE)
if errors:
raise AssertionError(f"valid High-Level reference failed: {errors}")
errors = []
verify.check_high_level_reference(
errors,
HIGH_LEVEL_REFERENCE.replace("effective_w = 964", "effective_w = 972", 1),
)
expected = (
"High-Level checklist item 3 has effective_w=972; "
"expected 1000 - 28 - 8 = 964"
)
if errors != [expected]:
raise AssertionError(f"stale effective width was not reported: {errors}")
errors = []
verify.check_high_level_reference(
errors,
HIGH_LEVEL_REFERENCE.replace("13. Check thirteen.", "11. Check thirteen."),
)
expected = (
"High-Level reproducibility checklist numbering is not sequential: "
"expected 1..13, found 1,2,3,4,5,6,7,8,9,10,11,12,11"
)
if errors != [expected]:
raise AssertionError(f"duplicate checklist number was not reported: {errors}")
print(
"PASS: docs sync checks references, strict-bundler packaging, profile surfaces, "
"and Factory install contract"
"PASS: docs sync checks references, strict-bundler packaging, routing surfaces, "
"Factory install contract, type-count routing, and High-Level invariants"
)
return 0