Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .tidyfactor
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "tidyfactor-doc",
"version": "1.5.0",
"version": "1.10.0",
"category": "development",
"description": "TidyFactor Doc — Code Documentation Builder & Dual-Engine Publishing Platform (MkDocs Material & Docsify) for AI Coding Agents",
"description": "TidyFactor Doc — Code Documentation Builder, ADR Architect, llms.txt Standard Generator, Link Auditor & Triple-Engine Publishing Platform (VitePress, MkDocs Material & Docsify) for AI Coding Agents",
"repository": "https://github.com/TidyFactor/Doc",
"npm": "@alwkala/tidyfactor-doc",
"compatibility": [
Expand Down
99 changes: 99 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,105 @@
All notable changes to `tidyfactor-doc` will be documented in this file.
This project adheres to [Semantic Versioning](https://semver.org/).

## [1.10.0] - 2026-09-10

### 🚀 Added — llms.txt & llms-full.txt Standard Generator for AI Agents
- **llms.txt Generator Command & Workflow (`references/commands/llms.md`, `references/workflows/generate-llmstxt.md`)**:
- Added dedicated `llms` command to generate and maintain `/llms.txt` (curated index) and `/llms-full.txt` (consolidated plain markdown bundle) conforming to the community standard ([llmstxt.org](https://llmstxt.org/)).
- Automated crawling of `/docs`, single `# H1` requirement, blockquote summary generation, and annotated markdown link lists.
- Injected discovery `<link rel="alternate" type="text/markdown" href="/llms.txt" ...>` headers across VitePress, MkDocs Material, and Docsify engines.
- **Operational Memory Specification (`references/memory/llmstxt-spec.md`)**:
- Codified the canonical specification for `llms.txt` and `llms-full.txt` syntax, sectioning (`## H2`), annotated descriptions, and HTTP discovery headers.
- **Unified Tooling Manifest (`manifest.json`)**:
- Integrated `llms` command into `audit_docs` and documentation lifecycle workflows.

---

## [1.9.0] - 2026-09-09

### 🚀 Added — Architectural Decision Records (ADR), Deep Docblock Scraping, Project Mindmaps & Asset Hygiene
- **Architectural Decision Record Generator (`references/commands/adr.md`, `references/workflows/generate-adr.md`)**:
- Added dedicated `adr` command with Context-Aware prompts to record technical choices, problem context, decision drivers, and consequences.
- Standardized on MADR (Markdown Architectural Decision Records) schema with index generation (`docs/adr/README.md`).
- **Deep Code Parsing in Collect Workflow (`references/workflows/collect.md`)**:
- Enriched Step 1 with automated scraping for PHPDoc (`@param`, `@return`, `@throws`, `@deprecated`) and JSDoc/TSDoc (`@param`, `@returns`, `@typedef`, `@template`) annotations.
- Mapped AST interface types and class properties directly to documentation templates.
- **Operational Memory Expansion**:
- Added `references/memory/adr-template.md`: Authoritative MADR record structure and master table of contents.
- Added `references/memory/project-mindmap.md`: Mermaid AST schemas for architecture layering, component topologies, and execution flows.
- Added `references/memory/naming-conventions.md`: Uniform naming conventions across PHP (PSR-1/PSR-12), TypeScript, Python, and doc slugs.
- Added `references/memory/tone-of-voice.md`: Non-negotiable technical writing rules (direct, action-oriented, zero marketing fluff).
- Added `references/memory/git-doc-sync-hook.md`: Pre-commit hook specification enforcing documentation updates alongside core code changes.
- **Automated Asset Hygiene & Orphan Detection (`scripts/clean_orphaned_assets.py`)**:
- Added script to scan all `.md` files for image references, identify unreferenced assets in `assets/`, detect duplicate files via SHA-256 hashes, and calculate WebP compression savings.
- **Unified Tooling Manifest (`manifest.json`)**:
- Registered `clean_orphaned_assets` tool with portable CLI patterns.
- Registered `adr` command in tool invocation mappings and decision gate options.

---

## [1.8.0] - 2026-09-09

### 🚀 Added — Documentation Hygiene Auditor, Keep a Changelog Architecture & Asset Optimization
- **Documentation Quality & Link Auditor (`references/commands/audit.md`, `references/workflows/audit.md`)**:
- Added dedicated `audit` command and workflow for sub-second deterministic doc scanning.
- Added relative markdown link integrity verification in `scripts/audit_docs.py` (`check_relative_links`) to detect broken local file links before release.
- Added Keep a Changelog structural validator (`check_changelog_format`) verifying SemVer release headers and standard change categories.
- **Changelog Workflow & SSOT Architecture (`references/workflows/generate-changelog.md`)**:
- Codified automated `generate-changelog` workflow strictly adhering to Keep a Changelog v1.1.0 and SemVer 2.0.0.
- Conventional Commits parser mapping git commits to standard sections (`Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`).
- Integrated changelog generation routing into `references/commands/generate.md`.
- **Operational Memory & Governance Templates (`references/memory/changelog-rules.md`, `references/memory/doc-templates.md`)**:
- Added `references/memory/changelog-rules.md` establishing release standards, SemVer bump formulas, and conventional commit mappings.
- Added standard `CHANGELOG.md` template to `references/memory/doc-templates.md`.
- Refreshed all memory verification timestamps (`<!-- last-verified: 2026-09-09 -->`).
- **Asset Deduplication & Hygiene (`assets/`)**:
- Removed duplicate 242KB asset (`assets/og-default.png`), saving 50% of the asset footprint without breaking references.
- **Unified Tooling & Decision Manifest (`manifest.json`)**:
- Expanded `audit_docs` tool contract with link integrity and changelog validation scopes.
- Registered `audit` and `vitepress` commands in tool invocation mappings and decision gate options.

---

## [1.7.0] - 2026-09-09

### 🚀 Added — Triple-Engine Publishing Platform (VitePress Integration) & Luxury RTL Design System
- **VitePress Publishing Engine (references/commands/vitepress.md)**: Added full VitePress SSG engine support alongside MkDocs Material and Docsify.
- **Ordered Workflow & Automation (references/workflows/vitepress.md)**: 6-step workflow covering scaffolding, multi-language subdirectory routing, luxury CSS injection, and zero-dead-link validation (npm run docs:build).
- **Master Configuration & Luxury Tokens (references/memory/vitepress-config.md)**: Codified complete ESM config.mjs schema, Alexandria + Cairo + JetBrains Mono typography, surgical RTL navbar flex order, and Quick-Navigation grid templates.
- **Luxury Hero & Actions Architecture**: Codified single-row CTA button flex safeguards (white-space: nowrap) and stable natural RTL Hero direction (Text/CTAs on right, Logo on left).
- **3-Column Feature Cards & Column Collapse Fix**: Codified explicit width assignment on .VPFeatures .item and BiDi text safeguards.
- **3-Way Engine Evaluation Matrix (references/memory/site-engines.md)**: Expanded to comprehensive 3-way evaluation across VitePress, MkDocs Material, and Docsify.

---

## [1.6.0] - 2026-09-08

### 🧠 Added — Dual-Mode Decision Architect (DM-DA) & Debate Mode Engine (CDL v2.0)
- **Interactive Interview & Debate Command (`brief`)**: Added `references/commands/brief.md` supporting trigger phrases `brief`, `interview`, `debate`, "استجوبني", and "ناقشني في معمارية التوثيق".
- **Dual Operational Modes (`references/workflows/brief.md`)**:
- **[MODE A] Smart 3-Round Protocol**: Fast-track structured alignment in 3 deterministic rounds (Purpose & Target Persona ➔ Architecture & Engine ➔ Hygiene & Safe Defaults) terminating with an explicit escalation gate prompt.
- **[MODE B] Relentless Debate & Interview (Debate Mode)**: Deep multi-turn architectural counter-questioning, challenging assumptions on static vs. SPA, bilingual overhead, and automated secret scrubbing. Strictly terminates only on `"END DEBATE"` / `"اعتماد"`, emitting a formal `docs/architectural_debate_synthesis.md` artifact.
- **Architectural Decision Matrix (`references/memory/decision-points.md`)**: Codified 5 core documentation dimensions (D1: Purpose & Scope, D2: Platform Engine, D3: Target Persona & Register, D4: Hygiene & Leak Policy, D5: Extraction Depth) with Boolean Skip Conditions for zero-overhead execution.
- **Declarative Gate Expansion (`manifest.json`)**: Expanded manifest schema v1.1.0 with formal `brief` decision gates for D1–D5 with local YAML persistence (`.tidyfactor/doc-brief.snapshot.yaml`).

---

## [1.5.1] - 2026-09-08

### 🏛️ Fixed & Synchronized — Governance Compliance (TidyFactor Skill Architect)
- **Memory Freshness (Rule 11)**: Added `<!-- last-verified: 2026-09-08 -->` stamps to all stack memory files (`js-ts.md`, `php.md`, `react-vue-next.md`).
- **Two-Tier Multi-Language Documentation (Rule 13)**:
- Integrated universal 8-language switcher bar into `README.md` and `README.ar.md`.
- Synchronized title banner versioning (`v1.5.1`) across all 8 market localizations (`README.md`, `README.ar.md`, `README.de.md`, `README.es.md`, `README.fa.md`, `README.fr.md`, `README.pt.md`, `README.zh.md`).
- **Contextual Decision Layer CDL v2.0 (Rule 14)**:
- Integrated Step 0 Context Delta Resolution into `references/workflows/init-docs.md` with auto-sensing for `doc_engine`, `target_scope`, and `audience_persona`.
- **Token Efficiency & YAML Primacy (Rule 15)**:
- Created canonical `brand.yaml` SSOT at skill root alongside `brand.json`.
- Updated `manifest.json` to persist decision snapshots to `.tidyfactor/doc-brief.snapshot.yaml` and discover from `brand.yaml`.

---

## [1.5.0] - 2026-09-02

### 🧠 Added — Contextual Decision Layer (CDL v1.1.0) & Declarative Decision Gates
Expand Down
19 changes: 14 additions & 5 deletions README.ar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center">

# 📚 TidyFactor Doc `v1.3.0`
### محرك استقراء الأكواد البرمجية، وتوليد مراجع الـ API، ومنصة النشر المزدوجة (MkDocs Material و Docsify)
# 📚 TidyFactor Doc `v1.10.0`
### محرك استقراء الأكواد البرمجية، وتوليد مراجع الـ API، ومعيار llms.txt، ومنصة النشر الثلاثية (VitePress و MkDocs Material و Docsify)

**بناء توثيقات فنية دقيقة، مستدامة، آمنة، وقابلة للتصفح لعصر التعاون بين المطورين ووكلاء الذكاء الاصطناعي.**

Expand All @@ -12,7 +12,9 @@
[![روابط نظيفة ونسبية](https://img.shields.io/badge/Links-Clean%20%26%20Relative-cyan.svg?style=for-the-badge)](#-معايير-الروابط-النسبية-والتصفح-النظيف)
[![توافق شامل مع وكلاء الذكاء الاصطناعي](https://img.shields.io/badge/AI%20Agents-Universal%20Compatibility-4285F4.svg?style=for-the-badge)](README.md)

[🌐 الموقع الرسمي](https://tidyfactor.com/) • [📚 مركز التوثيق](https://tidyfactor.com/documentation) • [🤝 الشريك (الوكالة)](https://alwkala.com/) • [⚡ سجل الأوامر](#-سجل-الأوامر-ومسارات-التوثيق-الأربعة) • [🛡️ الضمانات الأمنية](#-ضمانات-الأمان-وحجب-البيانات-الحساسة) • [📖 النسخة الإنجليزية (English)](README.md)
[ English ](README.md) • [ العربية ](README.ar.md) • [ فارسی ](README.fa.md) • [ Español ](README.es.md) • [ Português ](README.pt.md) • [ 简体中文 ](README.zh.md) • [ Deutsch ](README.de.md) • [ Français ](README.fr.md)

[🌐 الموقع الرسمي](https://tidyfactor.com/) • [📚 مركز التوثيق](https://tidyfactor.com/documentation) • [🤝 الشريك (الوكالة)](https://alwkala.com/) • [⚡ سجل الأوامر](#-سجل-الأوامر-ومسارات-التوثيق-الأربعة) • [🛡️ الضمانات الأمنية](#-ضمانات-الأمان-وحجب-البيانات-الحساسة)

<br/><br/>

Expand Down Expand Up @@ -62,17 +64,24 @@ graph LR

---

## 🏛️ سجل الأوامر ومسارات التوثيق الأربعة
## 🏛️ سجل الأوامر ومسارات التوثيق الشاملة

| نية المطور وطلب المستخدم | الأمر | مسارات العمل والذاكرة المحملة | المخرجات الناتجة |
|---|---|---|---|
| **"تأصيل سياق التوثيق، الاستجواب أو المناظرة المعمارية"** / "brief" / "debate" | `brief` | `workflows/brief.md`<br>`memory/decision-points.md` | وثيقة `.tidyfactor/doc-brief.snapshot.yaml` و `docs/architectural_debate_synthesis.md` |
| **"تجهيز وهيكلة مجلد التوثيق"** / "scaffold /docs" | `init` | `workflows/init-docs.md`<br>`memory/doc-tree.md` | مجلد `/docs`، ملف `docs/.doc-manifest.json`، وصفحة `docs/README.md` |
| **"استقراء وفحص الكود والمشروع"** / "gather facts" | `collect` | `workflows/collect.md`<br>`memory/collection-sources.md` | تقرير `docs/.collected/<target>.md` (تحليل منظم بالأبعاد الخمسة) |
| **"كتابة مرجع واجهة برمجة (API)"** / "API reference" | `generate` | `workflows/generate-api.md`<br>`memory/doc-templates.md`<br>`memory/stacks/*.md` | ملف `docs/api/<target>.md` (جداول المعاملات، القيم المرجعة، الأخطاء) |
| **"توليد أو تحديث سجل التغييرات"** / "generate changelog" | `generate` | `workflows/generate-changelog.md`<br>`memory/doc-templates.md`<br>`memory/changelog-rules.md` | ملف `CHANGELOG.md` في جذر المشروع (معيار Keep a Changelog و SemVer) |
| **"كتابة دليل إعداد وتشغيل"** / "setup guide" | `generate` | `workflows/generate-guide.md`<br>`memory/doc-templates.md` | ملف `docs/guides/<purpose-slug>.md` (دليل متخصص محدد الغرض) |
| **"توليد أو تحديث README الرئيسي"** / "generate readme" | `generate` | `workflows/generate-readme.md`<br>`memory/doc-templates.md` | ملف `README.md` في جذر المشروع (نظرة عامة، التثبيت، المتغيرات) |
| **"إضافة تعليقات برمجية للكود"** / "inline docblocks" | `generate` | `workflows/generate-inline.md`<br>`memory/stacks/*.md` | تعديل مباشر للملفات المصدرية بتعليقات PHPDoc / JSDoc / TSDoc |
| **"تحويل التوثيقات إلى موقع Docsify"** / "deploy portal" | `docsify` | `workflows/docsify.md`<br>`memory/docsify-config.md` | ملفات `docs/index.html` و`docs/_sidebar.md` (موقع تفاعلي متكامل) |
| **"نشر بوابة توثيق متكاملة"** / "محدد تفاعلي" | `site` | `memory/site-engines.md` | اختيار تفاعلي بين (`vitepress` أو `mkdocs` أو `docsify`) |
| **"إعداد بوابة VitePress الحديثة"** / "VitePress SSG" | `vitepress` | `workflows/vitepress.md`<br>`memory/vitepress-config.md` | ملفات `docs/.vitepress/config.mjs` وتنسيقات الـ RTL الفاخرة |
| **"إعداد بوابة MkDocs Material"** / "Python SSG" | `mkdocs` | `workflows/mkdocs.md`<br>`memory/mkdocs-config.md` | ملف `mkdocs.yml` و `docs/stylesheets/extra.css` |
| **"تحويل التوثيقات إلى موقع Docsify"** / "deploy portal" | `docsify` | `workflows/docsify.md`<br>`memory/docsify-config.md` | ملفات `docs/index.html` و`docs/_sidebar.md` (موقع تفاعلي فوري) |
| **"تدقيق جودة الوثائق والروابط"** / "audit docs" | `audit` | `workflows/audit.md`<br>`scripts/audit_docs.py` | تقرير تدقيق AST آلي (فحص الروابط والبيانات الحساسة وسجل التغييرات) |
| **"توثيق قرار معماري"** / "generate ADR" | `adr` | `workflows/generate-adr.md`<br>`memory/adr-template.md`<br>`memory/tone-of-voice.md` | ملف `docs/adr/NNNN-<slug>.md` وفهرس `docs/adr/README.md` |

---

Expand Down
2 changes: 1 addition & 1 deletion README.de.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">

# tidyfactor-doc `v1.3.0`
# tidyfactor-doc `v1.6.0`

**Codebase Documentation Builder & Dual-Engine Publishing Platform (MkDocs & Docsify) für KI-Coding-Agenten**

Expand Down
2 changes: 1 addition & 1 deletion README.es.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">

# tidyfactor-doc `v1.3.0`
# tidyfactor-doc `v1.6.0`

**Constructor de Documentación de Código y Motor de Publicación Dual (MkDocs & Docsify) para Agentes de IA**

Expand Down
2 changes: 1 addition & 1 deletion README.fa.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center" dir="rtl">

# tidyfactor-doc `v1.3.0`
# tidyfactor-doc `v1.6.0`

**موتور ساخت مستندات کد و انتشار دوگانه پورتال‌های مستندات (MkDocs و Docsify) برای ایجنت‌های هوش مصنوعی**

Expand Down
2 changes: 1 addition & 1 deletion README.fr.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">

# tidyfactor-doc `v1.3.0`
# tidyfactor-doc `v1.6.0`

**Générateur de Documentation de Codebase et Plateforme de Publication Double (MkDocs & Docsify) pour Agents d'IA**

Expand Down
Loading
Loading