Skip to content

Commit 26b5962

Browse files
authored
Merge pull request #102 from sonesuke/fix/docs-formatting
2 parents 52bafb0 + b25a54c commit 26b5962

6 files changed

Lines changed: 369 additions & 102 deletions

File tree

CHANGELOG.md

Lines changed: 57 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ All notable changes to this project will be documented in this file.
66

77
### Bug Fixes
88

9-
- *(test)* Resolve clippy cloned_ref_to_slice_refs warnings
10-
- *(parser)* Prevent block name overwrite by subsequent headings
11-
- *(vsix)* Resolve npm vulnerabilities and enable ci check (#72)
12-
- *(devcontainer)* Propagate CI env var for startup optimization (#84)
9+
- _(test)_ Resolve clippy cloned_ref_to_slice_refs warnings
10+
- _(parser)_ Prevent block name overwrite by subsequent headings
11+
- _(vsix)_ Resolve npm vulnerabilities and enable ci check (#72)
12+
- _(devcontainer)_ Propagate CI env var for startup optimization (#84)
1313
- Add tmux to devcontainer and fix remoteUser (#93)
1414
- Improve devcontainer configuration (#98)
1515

1616
### Features
1717

18-
- *(docker)* Optimize image size & fix CI environment (#86)
18+
- _(docker)_ Optimize image size & fix CI environment (#86)
1919
- Enhance template validation (DG007) and standardize use cases (#87)
20-
- *(core)* Implement DG007 template validation and fix templates (#88)
20+
- _(core)_ Implement DG007 template validation and fix templates (#88)
2121
- Refactor Configuration Specs and Enforce Strict Dependencies (#90)
2222
- Semantic error messages and traceability refactoring (#94)
23-
- *(cli)* Improve type, describe, and list command output (#95)
23+
- _(cli)_ Improve type, describe, and list command output (#95)
2424
- Enhance validate skill with template and structure checks
2525
- Enhance file placement validation with consistency checks
2626
- Add SRP check to validate skill
@@ -39,17 +39,17 @@ All notable changes to this project will be documented in this file.
3939
### Miscellaneous Tasks
4040

4141
- Update dependencies
42-
- *(deps)* Bump actions/download-artifact from 4 to 7 (#73)
43-
- *(deps)* Bump actions/checkout from 4 to 6 (#74)
44-
- *(deps)* Bump actions/upload-artifact from 4 to 6 (#78)
45-
- *(deps-dev)* Bump @types/node from 25.1.0 to 25.2.1 in /vsix (#77)
46-
- *(deps)* Bump github/codeql-action from 3 to 4 (#76)
47-
- *(deps-dev)* Bump @biomejs/biome from 2.3.13 to 2.3.14 in /vsix (#79)
48-
- *(ci)* Suppress git init default branch warning (conflict resolved) (#83)
49-
- *(devcontainer)* Wrap dev setup in CI check for startup optimization (#82)
50-
- *(deps)* Bump the dependencies group with 2 updates (#80)
51-
- *(deps-dev)* Bump @types/vscode from 1.108.1 to 1.109.0 in /vsix (#75)
52-
- *(deps)* Bump lsp-types from 0.94.1 to 0.97.0 in the dependencies group (#89)
42+
- _(deps)_ Bump actions/download-artifact from 4 to 7 (#73)
43+
- _(deps)_ Bump actions/checkout from 4 to 6 (#74)
44+
- _(deps)_ Bump actions/upload-artifact from 4 to 6 (#78)
45+
- _(deps-dev)_ Bump @types/node from 25.1.0 to 25.2.1 in /vsix (#77)
46+
- _(deps)_ Bump github/codeql-action from 3 to 4 (#76)
47+
- _(deps-dev)_ Bump @biomejs/biome from 2.3.13 to 2.3.14 in /vsix (#79)
48+
- _(ci)_ Suppress git init default branch warning (conflict resolved) (#83)
49+
- _(devcontainer)_ Wrap dev setup in CI check for startup optimization (#82)
50+
- _(deps)_ Bump the dependencies group with 2 updates (#80)
51+
- _(deps-dev)_ Bump @types/vscode from 1.108.1 to 1.109.0 in /vsix (#75)
52+
- _(deps)_ Bump lsp-types from 0.94.1 to 0.97.0 in the dependencies group (#89)
5353
- Integrate prettier for markdown formatting (#96)
5454
- Migrate slash commands to antigravity skills
5555
- Remove redundant docgraph skill and simplify align/refine skills
@@ -63,18 +63,17 @@ All notable changes to this project will be documented in this file.
6363

6464
### Performance
6565

66-
- *(ci)* Implement granular steps with persistent workspace cache (#85)
66+
- _(ci)_ Implement granular steps with persistent workspace cache (#85)
6767

6868
### Refactor
6969

7070
- Replace rumdl with custom pulldown-cmark parser and restore rules
71-
- *(lsp)* Remove tower-lsp and optimize dependencies (#69)
71+
- _(lsp)_ Remove tower-lsp and optimize dependencies (#69)
7272

7373
### Ci
7474

7575
- Use devcontainers/ci for release workflow (#70)
76-
- *(dependabot)* Add zed-extension config (#71)
77-
76+
- _(dependabot)_ Add zed-extension config (#71)
7877

7978
## [0.2.1] - 2026-02-06
8079

@@ -89,36 +88,36 @@ All notable changes to this project will be documented in this file.
8988
- Dummy bench file and doc lints
9089
- Move CARGO_TARGET_DIR to user home to fix permission denied in CI
9190
- Move CARGO_HOME to user home to resolve registry permission errors
92-
- *(ci)* Add packages:read permission to CI workflow for GHCR cache access
93-
- *(ci)* Add explicit ghcr login and use full image URL for cache
94-
- *(ci)* Pre-build debug dependency artifacts in Dockerfile to speed up CI
95-
- *(zed)* Update zed_extension_api to 0.7.0 and bind to Markdown language
91+
- _(ci)_ Add packages:read permission to CI workflow for GHCR cache access
92+
- _(ci)_ Add explicit ghcr login and use full image URL for cache
93+
- _(ci)_ Pre-build debug dependency artifacts in Dockerfile to speed up CI
94+
- _(zed)_ Update zed_extension_api to 0.7.0 and bind to Markdown language
9695
- Optimize devcontainer build config (#65)
9796

9897
### Documentation
9998

100-
- *(zed)* Add zed extension design and update installation guide
101-
- *(zed)* Separate zed installation into dedicated use case and add settings guide
102-
- *(readme)* Update zed installation guide and reorder options
99+
- _(zed)_ Add zed extension design and update installation guide
100+
- _(zed)_ Separate zed installation into dedicated use case and add settings guide
101+
- _(readme)_ Update zed installation guide and reorder options
103102

104103
### Features
105104

106105
- Consolidate development norms and add OSS constraint
107106
- Use GHCR for pre-built dev container for faster setup
108-
- *(lsp)* Implement real-time diagnostics and decouple core
109-
- *(zed)* Add zed extension, update docs and workflow
107+
- _(lsp)_ Implement real-time diagnostics and decouple core
108+
- _(zed)_ Add zed extension, update docs and workflow
110109

111110
### Miscellaneous Tasks
112111

113112
- Set default user to vscode in Dockerfile
114113
- Remove zed-extension/target from git and add .gitignore
115114
- Cleanup zed-extension artifacts and update .gitignore
116-
- *(release)* Automate CHANGELOG.md generation and commitment
117-
- *(release)* Bump version to 0.2.1 (#62)
118-
- *(release)* Allow release to continue if changelog push fails (#63)
119-
- *(release)* Remove zed extension from release and ci (#64)
115+
- _(release)_ Automate CHANGELOG.md generation and commitment
116+
- _(release)_ Bump version to 0.2.1 (#62)
117+
- _(release)_ Allow release to continue if changelog push fails (#63)
118+
- _(release)_ Remove zed extension from release and ci (#64)
120119
- Refine release workflow and documentation (#66)
121-
- *(release)* Prepare v0.2.1 (#67)
120+
- _(release)_ Prepare v0.2.1 (#67)
122121

123122
### Performance
124123

@@ -135,7 +134,7 @@ All notable changes to this project will be documented in this file.
135134
### Bug Fixes
136135

137136
- Ci failures (rustfmt and package-lock.json)
138-
- *(vscode)* Update @types/node to 20 and sync lockfile
137+
- _(vscode)_ Update @types/node to 20 and sync lockfile
139138
- Resolve unused variable warning
140139
- Ignore anchors and links inside code fences
141140
- Strip ID prefix from node name in headings
@@ -147,32 +146,32 @@ All notable changes to this project will be documented in this file.
147146
- Enforce ACT must be referenced by UC, update UC-WRITE actor
148147
- Clippy warnings
149148
- Run cargo fmt to resolve CI formatting failures
150-
- *(cli)* Resolve clippy warning in glob_to_regex
149+
- _(cli)_ Resolve clippy warning in glob_to_regex
151150
- Format code with cargo fmt
152151
- Ignore IDs and references inside code blocks
153152
- Format code with cargo fmt
154153
- Remove deprecated root_path usage in LSP server
155154
- Resolve clippy lint errors and borrow checker issues
156155
- Split cargo llvm-cov to support both lcov and html
157156
- Resolve TOML parse error in docgraph.toml
158-
- *(lsp)* Pass ignore config and add SECURITY.md to ignore list
157+
- _(lsp)_ Pass ignore config and add SECURITY.md to ignore list
159158
- Resolve clippy and fmt issues
160-
- *(ci)* Fix clippy warnings and include all files
159+
- _(ci)_ Fix clippy warnings and include all files
161160
- Apply cargo fmt to CLI handlers
162161
- Allow dead_code in common test utilities to fix CI failure
163162
- Consolidate LSP tests and fix formatting
164163
- Resolve unused code warnings by moving helpers and removing allow(dead_code)
165164
- Resolve deprecation warnings for assert_cmd and fix CI failure
166165
- Resolve all E2E test failures and deprecation warnings
167-
- *(core)* Ignore anchors and links within inline code and code blocks
166+
- _(core)_ Ignore anchors and links within inline code and code blocks
168167
- Resolve clippy warnings and formatting issues
169168
- Resolve clippy manual_pattern_char_comparison lints
170169
- Robust rename handler logic
171-
- *(lsp)* Resolve overlapping edits and canonicalize paths in rename
170+
- _(lsp)_ Resolve overlapping edits and canonicalize paths in rename
172171
- Resolve clippy lints and syntax errors in LSP handlers
173-
- *(core)* Resolve collapsible_if clippy warning in walk.rs
174-
- *(lsp)* Include ID in symbol names for workspace/document symbol search
175-
- *(test)* Update DG004 unit tests to match new function signature
172+
- _(core)_ Resolve collapsible_if clippy warning in walk.rs
173+
- _(lsp)_ Include ID in symbol names for workspace/document symbol search
174+
- _(test)_ Update DG004 unit tests to match new function signature
176175
- Replace verify command with type refinement workflow
177176
- Update docgraph.toml to explicitly define UC reference rules
178177
- Add --force to cargo install in devcontainer.json to avoid prompts
@@ -235,7 +234,7 @@ All notable changes to this project will be documented in this file.
235234
- Register new rules and dependencies
236235
- Add architecture node types (CTX, BB, RT, DEP, CC)
237236
- Finalize all reference rules and direction alignment
238-
- *(dg003)* Add strict file link validation with auto-fix
237+
- _(dg003)_ Add strict file link validation with auto-fix
239238
- Add list command with prefix matching support
240239
- Add trace command with up/down direction support
241240
- Add describe command for bidirectional relationship view
@@ -255,14 +254,14 @@ All notable changes to this project will be documented in this file.
255254
- Implement error handling strategy with thiserror and anyhow
256255
- Implement E2E testing strategy with assert_cmd
257256
- Introduce Biome for VSIX project and update CI/CD
258-
- *(cli)* Add type subcommand to display node types
257+
- _(cli)_ Add type subcommand to display node types
259258
- Optimize lint performance by refactoring DG004
260259
- Add CLI wrapper commands to docgraph-plugin
261260
- Add verify workflow command
262261
- Add refine-type workflow command
263262
- Add tidy workflow command
264263
- Add dev container configuration and update developer guide
265-
- *(devcontainer)* Add Claude Code installation and configuration
264+
- _(devcontainer)_ Add Claude Code installation and configuration
266265
- Add github release workflow and changelog configuration
267266
- Add installation scripts for macOS/Linux and Windows
268267

@@ -272,12 +271,12 @@ All notable changes to this project will be documented in this file.
272271
- Final formatting and lint fixes for describe command
273272
- Update Cargo.lock for LSP dependencies
274273
- Security hardening (CI audit, permissions, policy)
275-
- *(deps)* Bump softprops/action-gh-release from 1 to 2
274+
- _(deps)_ Bump softprops/action-gh-release from 1 to 2
276275
- Refactor ci.yml for efficiency and speed
277276
- Parallelize ci jobs (lint and test)
278-
- *(deps)* Bump toml in the dependencies group
277+
- _(deps)_ Bump toml in the dependencies group
279278
- Cleanup redundant release workflow and refine coverage visibility
280-
- *(deps)* Bump actions/checkout from 4 to 6
279+
- _(deps)_ Bump actions/checkout from 4 to 6
281280
- Relocate security policy to root as SECURITY.md
282281
- Rename doc/devel/README.md to guide.md
283282
- Split core_workflows.md and remove tests
@@ -287,19 +286,19 @@ All notable changes to this project will be documented in this file.
287286
- Rename markdown files to use kebab-case
288287
- Replace test_data with real docs in CI and guide
289288
- Remove empty tests directory
290-
- *(core)* Improve coverage and fix warnings
289+
- _(core)_ Improve coverage and fix warnings
291290
- Add blank lines for readability in SECURITY.md
292291
- Rename all IDs to underscore-separated format
293292
- Sync remaining LSP handlers with ID renaming
294-
- *(deps)* Bump actions/upload-artifact from 4 to 6
295-
- *(deps-dev)* Bump @types/node from 16.18.126 to 25.1.0 in /vsix
296-
- *(deps)* Bump vscode-languageclient from 8.1.0 to 9.0.1 in /vsix
297-
- *(deps-dev)* Bump typescript from 4.9.5 to 5.9.3 in /vsix
298-
- *(deps-dev)* Bump @vscode/vsce from 2.32.0 to 3.7.1 in /vsix
293+
- _(deps)_ Bump actions/upload-artifact from 4 to 6
294+
- _(deps-dev)_ Bump @types/node from 16.18.126 to 25.1.0 in /vsix
295+
- _(deps)_ Bump vscode-languageclient from 8.1.0 to 9.0.1 in /vsix
296+
- _(deps-dev)_ Bump typescript from 4.9.5 to 5.9.3 in /vsix
297+
- _(deps-dev)_ Bump @vscode/vsce from 2.32.0 to 3.7.1 in /vsix
299298
- Cleanup unused shell scripts and update documentation
300299
- Enforce strict consistency rules for Use Cases in docgraph.toml
301300
- Run docgraph check --fix
302-
- *(devcontainer)* Optimize startup speed using cargo-binstall
301+
- _(devcontainer)_ Optimize startup speed using cargo-binstall
303302
- Bump version to 0.2.0
304303

305304
### Refactor

docgraph-plugin/skills/align/SKILL.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,29 @@ description: Deep Consistency Gate - Verify Vertical and Horizontal relationship
55

66
# Deep Consistency Gate (Architecture & Meaning)
77

8-
This skill serves as the **gate for depth and relationship integrity** within the documentation graph. It focuses on ensuring that nodes are not only correct in isolation (as verified by `validate`) but also perfectly aligned with their context (Vertical) and their peers (Horizontal).
8+
This skill serves as the **gate for depth and relationship integrity** within the documentation graph. It focuses on
9+
ensuring that nodes are not only correct in isolation (as verified by `validate`) but also perfectly aligned with their
10+
context (Vertical) and their peers (Horizontal).
911

10-
> [!IMPORTANT]
11-
> This is an **Architecture & Meaning Gate**. Flag any semantic "fog" (unclear boundaries, implicit assumptions, or overloaded terms). Every node must be fully justified by its context.
12+
> [!IMPORTANT] This is an **Architecture & Meaning Gate**. Flag any semantic "fog" (unclear boundaries, implicit
13+
> assumptions, or overloaded terms). Every node must be fully justified by its context.
1214
1315
## Workflow Steps
1416

1517
### 0. Validation Pre-requisite
18+
1619
- **Level**: STRICT
17-
- **Policy**:
20+
- **Policy**:
1821
- If `validate` status is unknown or FAIL -> **STOP** and return FAIL.
1922
- Do not re-evaluate surface items (naming, templates) already covered by `validate`.
2023

2124
### 1. Vertical Consistency (Traceability & Context)
25+
2226
- **Level**: STRICT for missing links, HEURISTIC for semantic clarity.
2327
- **Vertical Expectations**:
24-
- **Parents (Inbound)**: Define the "Why" (intent, requirement, or goal).
25-
- **This Node**: Defines the "What" at its specific abstraction level.
26-
- **Children (Outbound)**: Define the "How" (realization, implementation, or breakdown).
28+
- **Parents (Inbound)**: Define the "Why" (intent, requirement, or goal).
29+
- **This Node**: Defines the "What" at its specific abstraction level.
30+
- **Children (Outbound)**: Define the "How" (realization, implementation, or breakdown).
2731

2832
1. **Context Check**: Use `docgraph describe <ID>` and verify:
2933
- Does the parent node explicitly justify the existence of this node?
@@ -32,60 +36,73 @@ This skill serves as the **gate for depth and relationship integrity** within th
3236
- Is this node's responsibility fully and exclusively covered by its children?
3337

3438
### 2. Horizontal Consistency (Peer Alignment & MECE)
39+
3540
- **Level**: HEURISTIC
36-
- **Baseline Rule**: Use the dominant pattern among existing peer nodes. Do not invent new abstraction levels unless proposing an explicit refactor.
41+
- **Baseline Rule**: Use the dominant pattern among existing peer nodes. Do not invent new abstraction levels unless
42+
proposing an explicit refactor.
3743

3844
1. **Peer Identification**: Use `docgraph list "<PREFIX>_*"`.
3945
2. **Overlap Check**: Verify Mutually Exclusive and Collectively Exhaustive (MECE) status.
4046
- Does this node's responsibility overlap with peer nodes?
4147
- Is the granularity consistent with the peer baseline?
4248

4349
### 3. Structural SRP Check
50+
4451
- **Level**: HEURISTIC
4552
- **Note**: `validate` checks surface SRP; `align` checks structural SRP (depth, cohesion, and abstraction fit).
4653

4754
1. **Cohesion**: Are all elements within this node tightly related to the "What" definition?
4855
2. **Abstraction**: Is the node at the correct level relative to its parents and peers?
4956

5057
### 4. Proposals & Impact Analysis
58+
5159
- **Level**: MANDATORY
5260

5361
When proposing changes (Clarify Context, Split, Merge, or Move):
62+
5463
1. **Affected Nodes**: List all nodes (parents, peers, children) that will be affected.
5564
2. **Re-validation**: Indicate whether `validate` must be re-run for any affected nodes.
5665
3. **Safety**: Ensure no existing references are broken without a remediation plan.
5766

5867
## Workflow Cases
5968

6069
### Case 1: TYPE_ID (e.g., FR, MOD)
70+
6171
- Perform a full graph consistency review for the given type.
6272

6373
### Case 2: NODE_ID (e.g., FR_LOGIN)
74+
6475
- **Status**: Focused Refinement.
65-
- Perform a deep analysis specifically for the node and its immediate relations. Do not scan the entire graph unless necessary for baseline identification.
76+
- Perform a deep analysis specifically for the node and its immediate relations. Do not scan the entire graph unless
77+
necessary for baseline identification.
6678

6779
## Alignment Analysis Report
80+
6881
You **must** provide the analysis in the following format:
6982

7083
### Target
84+
7185
- **Node/Scope**: [ID or Type]
7286
- **Baseline Peer Pattern**: [Description of dominant convention]
7387

7488
### Consistency Analysis
75-
| Dimension | Check Item | Result | Analysis / Evidence |
76-
|:---|:---|:---|:---|
77-
| **Prerequisite** | Validate PASS | PASS/FAIL | |
78-
| **Vertical** | Parents (Why) | PASS/FAIL | |
79-
| **Vertical** | Children (How) | PASS/FAIL | |
80-
| **Horizontal** | Peer MECE | PASS/FAIL | |
81-
| **SRP** | Abstraction Fit | PASS/FAIL | |
89+
90+
| Dimension | Check Item | Result | Analysis / Evidence |
91+
| :--------------- | :-------------- | :-------- | :------------------ |
92+
| **Prerequisite** | Validate PASS | PASS/FAIL | |
93+
| **Vertical** | Parents (Why) | PASS/FAIL | |
94+
| **Vertical** | Children (How) | PASS/FAIL | |
95+
| **Horizontal** | Peer MECE | PASS/FAIL | |
96+
| **SRP** | Abstraction Fit | PASS/FAIL | |
8297

8398
### Refinement Proposals
99+
84100
- **Proposal**: [Description]
85101
- **Affected IDs**: [List]
86102
- **Re-validate Required**: [Yes/No]
87103

88104
### Quality Gate Checklist
105+
89106
In your final report, you **must** include this checklist to demonstrate deep architectural verification:
90107

91108
- [ ] **Prerequisite PASS**: The node has successfully cleared the `validate` skill (Quality Gate).
@@ -95,7 +112,9 @@ In your final report, you **must** include this checklist to demonstrate deep ar
95112
- [ ] **Impact Analysis**: All affected nodes are listed, and re-validation needs are clearly stated.
96113

97114
## Final Decision
115+
98116
### Decision Semantics
117+
99118
- **PASS**: Node shows deep integrity and may be merged/applied.
100119
- **FAIL**: Structural or semantic issues identified. MUST NOT be merged.
101120

0 commit comments

Comments
 (0)