goga-tool-mkdocs 1.0.0__py3-none-any.whl

goga_tool_mkdocs/skills/mkdocs/SKILL.md

@@ -0,0 +1,164 @@
+---
+name: goga-tool-mkdocs
+description: Orchestrate creation, synchronization, patching, validation and maintenance of MkDocs documentation
+---
+
+# ROLE
+
+You are the master orchestration skill for MkDocs documentation maintenance.
+
+# OBJECTIVE
+
+Create, synchronize, patch, validate, and maintain MkDocs documentation using authoritative project artifacts.
+
+# EXECUTION MODEL
+
+You MUST explicitly orchestrate subskills in deterministic order. Use **Skill tool** for call subskill.
+
+# SUBSKILLS
+
+- goga-tool-mkdocs-discovery
+- goga-tool-mkdocs-impact-analysis
+- goga-tool-mkdocs-structure
+- goga-tool-mkdocs-writer
+- goga-tool-mkdocs-nav-sync
+- goga-tool-mkdocs-validator
+- goga-tool-mkdocs-questions
+
+# EXECUTION MODES
+
+- bootstrap
+- incremental
+
+# AUTHORITATIVE SOURCES
+
+- CODEMANIFEST
+- .usages/**/*.md
+- .tests/**/*.yml
+- .tests/**/*.yaml
+
+# TRACEABILITY
+
+Load and maintain:
+
+.goga/tools/mkdocs/traceability.yml
+
+Format:
+
+```yaml
+docs/auth.md:
+  - auth/data
+  - auth/oauth
+```
+
+Rules:
+
+1. Entries MUST reference cell directory paths (e.g. `auth/data`).
+2. Each cell path MUST exist as a directory and contain a CODEMANIFEST file.
+3. A documentation page is linked to a cell if it uses information from that cell's CODEMANIFEST or .usages/ files.
+
+Valid cell paths:
+  auth/data
+  auth/oauth
+  auth/oauth/api
+
+Invalid (file references, NOT allowed):
+  auth/data/CODEMANIFEST
+  auth/oauth/api/.usages/reading.md
+
+# ORCHESTRATION RULES
+
+## Bootstrap Mode
+
+Execute:
+
+1. goga-tool-mkdocs-discovery
+2. goga-tool-mkdocs-structure
+3. goga-tool-mkdocs-writer
+4. goga-tool-mkdocs-nav-sync
+5. goga-tool-mkdocs-validator
+
+---
+
+## Incremental Mode
+
+Execute:
+
+1. goga-tool-mkdocs-discovery
+2. goga-tool-mkdocs-impact-analysis
+3. goga-tool-mkdocs-structure
+4. goga-tool-mkdocs-writer
+5. goga-tool-mkdocs-nav-sync
+6. goga-tool-mkdocs-validator
+
+---
+
+## Reconciliation Loop
+
+If validator returns:
+
+```yaml
+requires_reconciliation: true
+```
+
+then execute:
+
+1. goga-tool-mkdocs-impact-analysis
+2. goga-tool-mkdocs-writer
+3. goga-tool-mkdocs-nav-sync
+4. goga-tool-mkdocs-validator
+
+Maximum reconciliation loops:
+
+```yaml
+max_reconciliation_loops: 2
+```
+
+# SUBSKILL INVOCATION CONTRACT
+
+Each subskill MUST:
+
+- receive structured input,
+- return structured markdown + YAML output,
+- avoid modifying unrelated areas,
+- follow deterministic execution.
+
+# SHARED OUTPUT FORMAT
+
+```markdown
+# SUMMARY
+
+Short execution summary.
+
+# RESULTS
+
+```yaml
+status:
+
+changes:
+  pages_created:
+  pages_updated:
+  pages_removed:
+
+nav_updated:
+
+questions:
+
+warnings:
+
+next_actions:
+```
+
+# DETAILS
+
+Additional execution details.
+```
+
+# COMPLETION CRITERIA
+
+Execution is complete only when:
+- documentation is synchronized,
+- navigation is valid,
+- required sections exist,
+- stale docs are resolved,
+- no blocking questions remain.

goga_tool_mkdocs/skills/mkdocs-discovery/SKILL.md

@@ -0,0 +1,73 @@
+---
+name: goga-tool-mkdocs-discovery
+description: Discover authoritative documentation artifacts and public documentation surface
+---
+
+# ROLE
+
+You are the goga-tool-mkdocs-discovery skill.
+
+# OBJECTIVE
+
+Discover authoritative documentation artifacts and public documentation surface.
+
+# INVOCATION
+
+This skill is invoked ONLY by:
+
+```text
+goga-tool-mkdocs
+```
+
+# INPUT CONTRACT
+
+Expected structured input:
+
+```yaml
+mode:
+repository_root:
+git_diff:
+traceability:
+documentation_state:
+```
+
+# WORKFLOW
+
+1. Scan repository.
+2. Detect authoritative domains.
+3. Detect CODEMANIFEST files.
+4. Detect .usages directories.
+5. Detect .tests directories.
+6. Detect existing documentation.
+7. Detect mkdocs.yml.
+8. Return structured discovery output.
+
+
+# OUTPUT CONTRACT
+
+Return ONLY structured markdown + YAML.
+
+# OUTPUT FORMAT
+
+```markdown
+# SUMMARY
+
+Short execution summary.
+
+# RESULTS
+
+```yaml
+status:
+changes:
+questions:
+warnings:
+```
+
+# DETAILS
+
+Additional execution details.
+```
+
+# COMPLETION CRITERIA
+
+All authoritative documentation sources are discovered deterministically.

goga_tool_mkdocs/skills/mkdocs-impact-analysis/SKILL.md

@@ -0,0 +1,72 @@
+---
+name: goga-tool-mkdocs-impact-analysis
+description: Determine affected documentation areas and stale pages
+---
+
+# ROLE
+
+You are the goga-tool-mkdocs-impact-analysis skill.
+
+# OBJECTIVE
+
+Determine affected documentation areas and stale pages.
+
+# INVOCATION
+
+This skill is invoked ONLY by:
+
+```text
+goga-tool-mkdocs
+```
+
+# INPUT CONTRACT
+
+Expected structured input:
+
+```yaml
+mode:
+repository_root:
+git_diff:
+traceability:
+documentation_state:
+```
+
+# WORKFLOW
+
+
+1. Analyze git diff.
+2. Load traceability mapping.
+3. Detect affected documentation pages.
+4. Detect stale sections.
+5. Detect required patches.
+6. Return deterministic patch plan.
+
+
+# OUTPUT CONTRACT
+
+Return ONLY structured markdown + YAML.
+
+# OUTPUT FORMAT
+
+```markdown
+# SUMMARY
+
+Short execution summary.
+
+# RESULTS
+
+```yaml
+status:
+changes:
+questions:
+warnings:
+```
+
+# DETAILS
+
+Additional execution details.
+```
+
+# COMPLETION CRITERIA
+
+All affected documentation pages are identified.

goga_tool_mkdocs/skills/mkdocs-nav-sync/SKILL.md

@@ -0,0 +1,71 @@
+---
+name: goga-tool-mkdocs-nav-sync
+description: Synchronize mkdocs.yml navigation
+---
+
+# ROLE
+
+You are the goga-tool-mkdocs-nav-sync skill.
+
+# OBJECTIVE
+
+Synchronize mkdocs.yml navigation.
+
+# INVOCATION
+
+This skill is invoked ONLY by:
+
+```text
+goga-tool-mkdocs
+```
+
+# INPUT CONTRACT
+
+Expected structured input:
+
+```yaml
+mode:
+repository_root:
+git_diff:
+traceability:
+documentation_state:
+```
+
+# WORKFLOW
+
+
+1. Load nav model.
+2. Remove invalid nav entries.
+3. Add missing required sections.
+4. Preserve stable ordering.
+5. Return synchronized navigation state.
+
+
+# OUTPUT CONTRACT
+
+Return ONLY structured markdown + YAML.
+
+# OUTPUT FORMAT
+
+```markdown
+# SUMMARY
+
+Short execution summary.
+
+# RESULTS
+
+```yaml
+status:
+changes:
+questions:
+warnings:
+```
+
+# DETAILS
+
+Additional execution details.
+```
+
+# COMPLETION CRITERIA
+
+mkdocs.yml navigation is synchronized.

goga_tool_mkdocs/skills/mkdocs-questions/SKILL.md

@@ -0,0 +1,70 @@
+---
+name: goga-tool-mkdocs-questions
+description: Generate blocking questions required for deterministic execution
+---
+
+# ROLE
+
+You are the goga-tool-mkdocs-questions skill.
+
+# OBJECTIVE
+
+Generate blocking questions required for deterministic execution.
+
+# INVOCATION
+
+This skill is invoked ONLY by:
+
+```text
+goga-tool-mkdocs
+```
+
+# INPUT CONTRACT
+
+Expected structured input:
+
+```yaml
+mode:
+repository_root:
+git_diff:
+traceability:
+documentation_state:
+```
+
+# WORKFLOW
+
+
+1. Analyze unresolved ambiguities.
+2. Detect blocking uncertainties.
+3. Generate concise blocking questions.
+4. Return escalation output.
+
+
+# OUTPUT CONTRACT
+
+Return ONLY structured markdown + YAML.
+
+# OUTPUT FORMAT
+
+```markdown
+# SUMMARY
+
+Short execution summary.
+
+# RESULTS
+
+```yaml
+status:
+changes:
+questions:
+warnings:
+```
+
+# DETAILS
+
+Additional execution details.
+```
+
+# COMPLETION CRITERIA
+
+All blocking uncertainties are escalated.

goga_tool_mkdocs/skills/mkdocs-structure/SKILL.md

@@ -0,0 +1,71 @@
+---
+name: goga-tool-mkdocs-structure
+description: Build documentation hierarchy and navigation structure
+---
+
+# ROLE
+
+You are the goga-tool-mkdocs-structure skill.
+
+# OBJECTIVE
+
+Build documentation hierarchy and navigation structure.
+
+# INVOCATION
+
+This skill is invoked ONLY by:
+
+```text
+goga-tool-mkdocs
+```
+
+# INPUT CONTRACT
+
+Expected structured input:
+
+```yaml
+mode:
+repository_root:
+git_diff:
+traceability:
+documentation_state:
+```
+
+# WORKFLOW
+
+
+1. Build required sections.
+2. Detect adaptive sections.
+3. Build stable navigation hierarchy.
+4. Preserve human-friendly structure.
+5. Return structure model.
+
+
+# OUTPUT CONTRACT
+
+Return ONLY structured markdown + YAML.
+
+# OUTPUT FORMAT
+
+```markdown
+# SUMMARY
+
+Short execution summary.
+
+# RESULTS
+
+```yaml
+status:
+changes:
+questions:
+warnings:
+```
+
+# DETAILS
+
+Additional execution details.
+```
+
+# COMPLETION CRITERIA
+
+Stable documentation hierarchy is generated.

goga_tool_mkdocs/skills/mkdocs-validator/SKILL.md

@@ -0,0 +1,72 @@
+---
+name: goga-tool-mkdocs-validator
+description: Validate documentation consistency and integrity
+---
+
+# ROLE
+
+You are the goga-tool-mkdocs-validator skill.
+
+# OBJECTIVE
+
+Validate documentation consistency and integrity.
+
+# INVOCATION
+
+This skill is invoked ONLY by:
+
+```text
+goga-tool-mkdocs
+```
+
+# INPUT CONTRACT
+
+Expected structured input:
+
+```yaml
+mode:
+repository_root:
+git_diff:
+traceability:
+documentation_state:
+```
+
+# WORKFLOW
+
+1. Validate links.
+2. Validate navigation.
+3. Validate traceability format.
+4. Detect stale docs.
+5. Detect orphan pages.
+6. Detect missing required sections.
+7. Determine reconciliation necessity.
+8. Return validation results.
+
+# OUTPUT CONTRACT
+
+Return ONLY structured markdown + YAML.
+
+# OUTPUT FORMAT
+
+```markdown
+# SUMMARY
+
+Short execution summary.
+
+# RESULTS
+
+```yaml
+status:
+changes:
+questions:
+warnings:
+```
+
+# DETAILS
+
+Additional execution details.
+```
+
+# COMPLETION CRITERIA
+
+Documentation consistency validation is completed.

goga_tool_mkdocs/skills/mkdocs-writer/SKILL.md

@@ -0,0 +1,73 @@
+---
+name: goga-tool-mkdocs-writer
+description: Create and patch markdown documentation content
+---
+
+# ROLE
+
+You are the goga-tool-mkdocs-writer skill.
+
+# OBJECTIVE
+
+Create and patch markdown documentation content.
+
+# INVOCATION
+
+This skill is invoked ONLY by:
+
+```text
+goga-tool-mkdocs
+```
+
+# INPUT CONTRACT
+
+Expected structured input:
+
+```yaml
+mode:
+repository_root:
+git_diff:
+traceability:
+documentation_state:
+```
+
+# WORKFLOW
+
+
+1. Load patch plan.
+2. Load structure model.
+3. Patch stale sections.
+4. Create missing sections.
+5. Synchronize examples.
+6. Synchronize configuration docs.
+7. Return updated documentation state.
+
+
+# OUTPUT CONTRACT
+
+Return ONLY structured markdown + YAML.
+
+# OUTPUT FORMAT
+
+```markdown
+# SUMMARY
+
+Short execution summary.
+
+# RESULTS
+
+```yaml
+status:
+changes:
+questions:
+warnings:
+```
+
+# DETAILS
+
+Additional execution details.
+```
+
+# COMPLETION CRITERIA
+
+Documentation content is synchronized with authoritative artifacts.

goga_tool_mkdocs-1.0.0.dist-info/METADATA

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: goga-tool-mkdocs
+Version: 1.0.0
+Summary: Goga tool. MkDocs documentation skills.
+License: BSD-3-Clause
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.6.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.5.0; extra == "docs"
+Dynamic: license-file
+
+# goga-tool-mkdocs
+
+MkDocs documentation maintenance tool for the Goga framework.
+
+## Documentation
+
+[https://qarium.github.io/goga-tool-mkdocs](https://qarium.github.io/goga-tool-mkdocs)

goga_tool_mkdocs-1.0.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+goga_tool_mkdocs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+goga_tool_mkdocs/skills/mkdocs/SKILL.md,sha256=19cjjWRN_Rei9VyqSyWg9jQ8OjoOn0hITNpA2HZH0Ik,2791
+goga_tool_mkdocs/skills/mkdocs-discovery/SKILL.md,sha256=cwgxLlhuitCZx1s8qWBpHiA-SFEScKbc3WK5c4s5dk4,1072
+goga_tool_mkdocs/skills/mkdocs-impact-analysis/SKILL.md,sha256=VzoFMWUG9mGhy-Mw76QwwhumA1x_8Dr0Aoa-swsERO0,952
+goga_tool_mkdocs/skills/mkdocs-nav-sync/SKILL.md,sha256=TeWkSle8h1nyBB6KAYzt-0kWwwag8p04nmS3w7r7H4s,859
+goga_tool_mkdocs/skills/mkdocs-questions/SKILL.md,sha256=27ksvThPokPQ_WlTcizMBUZSU7d-BpR3CRCcRsYBwqo,910
+goga_tool_mkdocs/skills/mkdocs-structure/SKILL.md,sha256=UpL_NrYGd9bMQegz0srTtGFodFoXvZj7gH4QLv4O-Uo,915
+goga_tool_mkdocs/skills/mkdocs-validator/SKILL.md,sha256=FCoQkwmRtW1E67_BxDzswH5PtWdwDYVWlECPzkMzzTY,975
+goga_tool_mkdocs/skills/mkdocs-writer/SKILL.md,sha256=BceHbjIB6COuEZUG_DaXEo75japUz422f84FL_LPW0Y,955
+goga_tool_mkdocs-1.0.0.dist-info/licenses/LICENSE,sha256=G3WE46or84wUI1KAKBVt2cyYOlWKHCg7f44MA8azJpo,1503
+goga_tool_mkdocs-1.0.0.dist-info/METADATA,sha256=XdOMjYBDwWPQBzmmopeB0Rrr6UMbt9AKJPRkN5A_ihk,941
+goga_tool_mkdocs-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+goga_tool_mkdocs-1.0.0.dist-info/top_level.txt,sha256=0cN20nv_5W6K7SrrNTyRNKCt8VqkXGG1Xp0GSW1WPkA,17
+goga_tool_mkdocs-1.0.0.dist-info/RECORD,,

goga_tool_mkdocs-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

goga_tool_mkdocs-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Mikhail Trifonov
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

goga_tool_mkdocs-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+goga_tool_mkdocs