@tidyfactor/doc 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.tidyfactor +16 -0
- package/AGENTS.md +10 -0
- package/CHANGELOG.md +75 -0
- package/LICENSE +17 -0
- package/README.ar.md +180 -0
- package/README.de.md +44 -0
- package/README.es.md +44 -0
- package/README.fa.md +44 -0
- package/README.fr.md +44 -0
- package/README.md +198 -0
- package/README.pt.md +44 -0
- package/README.zh.md +44 -0
- package/SKILL.md +36 -0
- package/assets/hero-banner.png +0 -0
- package/assets/og-default.png +0 -0
- package/bin/add-skill.js +27 -0
- package/brand.json +13 -0
- package/package.json +59 -0
- package/references/commands/collect.md +15 -0
- package/references/commands/docsify.md +15 -0
- package/references/commands/generate.md +23 -0
- package/references/commands/init.md +15 -0
- package/references/commands/mkdocs.md +15 -0
- package/references/commands/site.md +23 -0
- package/references/memory/collection-sources.md +47 -0
- package/references/memory/doc-templates.md +73 -0
- package/references/memory/doc-tree.md +37 -0
- package/references/memory/docsify-config.md +273 -0
- package/references/memory/mkdocs-config.md +170 -0
- package/references/memory/site-engines.md +54 -0
- package/references/memory/stacks/js-ts.md +45 -0
- package/references/memory/stacks/php.md +33 -0
- package/references/memory/stacks/react-vue-next.md +50 -0
- package/references/workflows/collect.md +25 -0
- package/references/workflows/docsify.md +19 -0
- package/references/workflows/generate-api.md +21 -0
- package/references/workflows/generate-guide.md +20 -0
- package/references/workflows/generate-inline.md +20 -0
- package/references/workflows/generate-readme.md +20 -0
- package/references/workflows/init-docs.md +18 -0
- package/references/workflows/mkdocs.md +44 -0
- package/tools/build-skill.js +152 -0
- package/tools/validate_skill.py +124 -0
package/.tidyfactor
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "tidyfactor-doc",
|
|
3
|
+
"version": "1.3.0",
|
|
4
|
+
"category": "architecture",
|
|
5
|
+
"description": "TidyFactor Doc - Code Documentation Builder & Dual-Engine Publishing Platform (MkDocs Material & Docsify)",
|
|
6
|
+
"repository": "https://github.com/TidyFactor/Doc",
|
|
7
|
+
"npm": "@alwkala/tidyfactor-doc",
|
|
8
|
+
"compatibility": [
|
|
9
|
+
"antigravity",
|
|
10
|
+
"claude-code",
|
|
11
|
+
"cursor",
|
|
12
|
+
"codex",
|
|
13
|
+
"windsurf"
|
|
14
|
+
],
|
|
15
|
+
"license": "Apache-2.0"
|
|
16
|
+
}
|
package/AGENTS.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# AGENTS.md — TidyFactor Doc Governance Rules
|
|
2
|
+
|
|
3
|
+
This file governs all AI coding agents working on or with `tidyfactor-doc`.
|
|
4
|
+
|
|
5
|
+
## Core Invariants
|
|
6
|
+
1. **SSOT Rule:** `tidyfactor-doc/` in Skills-LAB is the single source of truth.
|
|
7
|
+
2. **Docs in `/docs` Only:** Generated documentation artifacts MUST live under `/docs` (except root `README.md`).
|
|
8
|
+
3. **No Assumed Details:** `generate` never invents facts or env vars not gathered during `collect`.
|
|
9
|
+
4. **Docsify Persistence:** Always generate `alias: { '/.*/_sidebar.md': '/_sidebar.md' }` and root-relative paths.
|
|
10
|
+
5. **SemVer SSOT:** All changes must bump version and update `CHANGELOG.md`.
|
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# CHANGELOG — TidyFactor Doc
|
|
2
|
+
|
|
3
|
+
All notable changes to `tidyfactor-doc` will be documented in this file.
|
|
4
|
+
This project adheres to [Semantic Versioning](https://semver.org/).
|
|
5
|
+
|
|
6
|
+
## [1.2.1] - 2026-08-25
|
|
7
|
+
|
|
8
|
+
### Fixed
|
|
9
|
+
- **CLI Executable & NPX Packaging**: Added standard `"add-skill": "bin/add-skill.js"` mapping in `package.json` to ensure unified `npx @tidyfactor/cli-doc add-skill` execution.
|
|
10
|
+
- **Workflow Compliance**: Standardized `## Validation checklist` headers across all 8 workflows.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## [1.3.0] - 2026-08-29
|
|
15
|
+
|
|
16
|
+
### Added - Global Multi-Tier & Multi-Language Documentation Architecture
|
|
17
|
+
- **Rule 13 Implementation**: Two-tier documentation separation between Canonical Technical Documentation (`README.md` SSOT) and First-Class Market Localizations.
|
|
18
|
+
- **Universal Multi-Language Switcher**: Standardized 8-language switcher navigation bar across all documentation files (`EN`, `AR`, `FA`, `ES`, `PT`, `ZH`, `DE`, `FR`).
|
|
19
|
+
- **First-Class Localized Developer Adoption Guides**: `README.es.md`, `README.pt.md`, `README.fa.md`, `README.zh.md`, `README.de.md`, `README.fr.md`.
|
|
20
|
+
- **Automated Validation & Packaging**: Updated `tools/build-skill.js` and `tools/validate_skill.py`.
|
|
21
|
+
|
|
22
|
+
## [1.2.0] - 2026-08-25
|
|
23
|
+
|
|
24
|
+
### Added
|
|
25
|
+
- **MkDocs Material Publishing Engine**:
|
|
26
|
+
- Full static HTML compilation track for high-performance production doc portals.
|
|
27
|
+
- Native bilingual parallel build support (`/` and `/ar/`) via `mkdocs-static-i18n`.
|
|
28
|
+
- Built-in Lunr.js offline search indexing (English + Arabic tokenization).
|
|
29
|
+
- Neo-Brutalist luxury styling tokens (`tidyfactor-light` & `tidyfactor-dark`) via `stylesheets/extra.css`.
|
|
30
|
+
- macOS-style terminal dots on highlighted code blocks with line spans.
|
|
31
|
+
- GitHub-style alert callout transformer (`[!IMPORTANT]`, `[!NOTE]`, `[!WARNING]`, `[!TIP]`) via `javascripts/extra.js`.
|
|
32
|
+
- Local Apache subfolder transparent routing via `.htaccess`.
|
|
33
|
+
- **Interactive Engine Selector Command (`site`)**:
|
|
34
|
+
- Interactive evaluation matrix in `references/commands/site.md` and `references/memory/site-engines.md`.
|
|
35
|
+
- Auto-detection of local Python/pip environment vs. zero-build CDN requirements.
|
|
36
|
+
- Clear user choice and recommendation guidance between MkDocs Material and Docsify.
|
|
37
|
+
- **Dedicated Direct Commands**:
|
|
38
|
+
- `mkdocs`: Direct entry point for MkDocs Material static portal compilation.
|
|
39
|
+
- `docsify`: Direct entry point for Docsify zero-build lightweight SPA.
|
|
40
|
+
- **New Workflows & Memory Specs**:
|
|
41
|
+
- `references/workflows/mkdocs.md`: End-to-end scaffolding, building, and validation checklist.
|
|
42
|
+
- `references/memory/mkdocs-config.md`: Master `mkdocs.yml` schema, theme configuration, and i18n rules.
|
|
43
|
+
- `references/memory/site-engines.md`: Technical comparison between Docsify and MkDocs Material.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## [1.1.0] - 2026-08-20
|
|
48
|
+
|
|
49
|
+
### Added
|
|
50
|
+
- **Security Sanitization Constraint (Zero Sensitive Data Leakage)**:
|
|
51
|
+
- Enforced strict automated redaction of sensitive credentials across all workflows and memory files.
|
|
52
|
+
- Prohibited real API keys, passwords, database credentials, secret auth tokens, and private server IP addresses from leaking into `/docs`.
|
|
53
|
+
- Added safe placeholder standard replacements table in `references/memory/collection-sources.md` (RFC 5737 doc IP ranges, dummy token formats).
|
|
54
|
+
- **Clean Relative Links Constraint (Clean Relative Links Only)**:
|
|
55
|
+
- Prohibited local machine URLs (`file:///C:/...`, `file:c:`, and absolute workstation paths) in all generated documentation.
|
|
56
|
+
- Mandated clean relative markdown links (`./docs/README.md`, `../api/project.md`) and standard public URLs.
|
|
57
|
+
- **Workflow & Memory Hardening**:
|
|
58
|
+
- Updated `collect.md`, `generate-api.md`, `generate-guide.md`, `generate-readme.md`, `generate-inline.md`, and `docsify.md` with explicit validation checkboxes for zero credential leaks and clean link paths.
|
|
59
|
+
- Updated `doc-templates.md` to showcase secure dummy placeholders in environment variable tables and relative link cross-references.
|
|
60
|
+
- Added automated build pipeline script (`tools/build-skill.js`) for packaging and multi-target synchronization.
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## [1.0.0] - 2026-08-19
|
|
65
|
+
|
|
66
|
+
### Added
|
|
67
|
+
- Initial canonical release of `tidyfactor-doc` under the TidyFactor Skills-LAB ecosystem.
|
|
68
|
+
- Standard 4-command router architecture in `SKILL.md`:
|
|
69
|
+
- `init`: Scaffolds standard `/docs` folder structure and manifest.
|
|
70
|
+
- `collect`: Non-destructive codebase analysis for PHP, TS/JS, and React/Next stacks.
|
|
71
|
+
- `generate`: Produces API references, developer setup guides, inline docblocks, and READMEs.
|
|
72
|
+
- `docsify`: Generates responsive Docsify documentation websites with persistent subfolder sidebar routing.
|
|
73
|
+
- Stack-specific memory rules for PHP 8, TypeScript, JavaScript, and React/Vue/Next component docs.
|
|
74
|
+
- Full cross-agent compatibility across Google Antigravity, Claude Code, Cursor, Codex, and Windsurf.
|
|
75
|
+
- Packaging as `@tidyfactor/doc` under Apache License 2.0.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
Copyright 2026 TidyFactor Ecosystem & Alwkala Digital Agency (https://alwkala.com)
|
|
6
|
+
|
|
7
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
8
|
+
you may not use this file except in compliance with the License.
|
|
9
|
+
You may obtain a copy of the License at
|
|
10
|
+
|
|
11
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
+
|
|
13
|
+
Unless required by applicable law or agreed to in writing, software
|
|
14
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
15
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
16
|
+
See the License for the specific language governing permissions and
|
|
17
|
+
limitations under the License.
|
package/README.ar.md
ADDED
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# 📚 TidyFactor Doc `v1.3.0`
|
|
4
|
+
### محرك استقراء الأكواد البرمجية، وتوليد مراجع الـ API، ومنصة النشر المزدوجة (MkDocs Material و Docsify)
|
|
5
|
+
|
|
6
|
+
**بناء توثيقات فنية دقيقة، مستدامة، آمنة، وقابلة للتصفح لعصر التعاون بين المطورين ووكلاء الذكاء الاصطناعي.**
|
|
7
|
+
|
|
8
|
+
[](https://www.npmjs.com/package/@tidyfactor/doc)
|
|
9
|
+
[](LICENSE)
|
|
10
|
+
[](https://github.com/TidyFactor/Doc)
|
|
11
|
+
[](#-ضمانات-الأمان-وحجب-البيانات-الحساسة)
|
|
12
|
+
[](#-معايير-الروابط-النسبية-والتصفح-النظيف)
|
|
13
|
+
[](README.md)
|
|
14
|
+
|
|
15
|
+
[🌐 الموقع الرسمي](https://tidyfactor.com/) • [📚 مركز التوثيق](https://tidyfactor.com/documentation) • [🤝 الشريك (الوكالة)](https://alwkala.com/) • [⚡ سجل الأوامر](#-سجل-الأوامر-ومسارات-التوثيق-الأربعة) • [🛡️ الضمانات الأمنية](#-ضمانات-الأمان-وحجب-البيانات-الحساسة) • [📖 النسخة الإنجليزية (English)](README.md)
|
|
16
|
+
|
|
17
|
+
<br/><br/>
|
|
18
|
+
|
|
19
|
+
<p align="center">
|
|
20
|
+
<img src="assets/hero-banner.png" alt="TidyFactor Doc Hero Banner" width="100%" />
|
|
21
|
+
</p>
|
|
22
|
+
|
|
23
|
+
</div>
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
> [!NOTE]
|
|
28
|
+
> **TidyFactor Doc** هو محرك حتمي لبناء التوثيقات الفنية ومواقع Docsify التفاعلية مخصص لوكلاء البرمجة الذكية (*Google Antigravity, Claude Code, Cursor, Codex, Windsurf*). يقوم باستقراء قواعد الأكواد والمشاريع البرمجية بدقة عبر فحص شجرة التعليمات البرمجية، وتاريخ التعديلات في Git، ومتغيرات بيئة التشغيل، وأنماط معالجة الأخطاء، لينتج مراكز توثيق متكاملة تحت مجلد `/docs` بدون أي تسريب للبيانات الحساسة أو روابط محلية معطوبة.
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 🌟 القيمة المضافة ولماذا TidyFactor Doc؟
|
|
33
|
+
|
|
34
|
+
| للمطورين وقادة الفرق التقنية | لوكلاء البرمجة الذكية (AI Agents) | للمشاريع البرمجية والشركات |
|
|
35
|
+
|---|---|---|
|
|
36
|
+
| **انعدام الكتابة اليدوية**: استخراج تلقائي لمعمارية المشروع، وتواقيع الـ API، وخطوات التثبيت مباشرة من الكود المصدري. | **توجيه موفر للرموز (Tokens)**: موجه `SKILL.md` ذكي (~350 رمزاً) يحمّل مسار العمل وسياق الذاكرة المطلوب فقط. | **موقع Docsify فوري**: أمر واحد يحول مجلد `/docs` إلى بوابة توثيق ويب تفاعلية سريعة ومزودة بمحرك بحث فوري. |
|
|
37
|
+
| **منع تسريب البيانات السرية**: حجب وتنقيح تلقائي لمفاتيح API، وكلمات المرور، وبيانات قواعد البيانات، وعناوين IP. | **الاعتماد على الحقائق فقط**: منع اختلاق أي دوال أو معلمات غير موجودة؛ كل حقيقة موثقة مستندة لنتائج الفحص. | **دعم لغات متعددة (Polyglot)**: قوالب جاهزة لـ PHP 8+، وTypeScript، وJavaScript ES Modules، ومكونات React/Vue/Next. |
|
|
38
|
+
| **روابط نسبية نظيفة**: إزالة تامة لروابط `file:///` والمسارات المطلقة (`C:\...`) لضمان عمل التوثيق في أي بيئة. | **تحقق حتمي صارم**: كل مسار عمل يمتلك قائمة تدقيق وتتبع آلي للحالة في `docs/.doc-manifest.json`. | **دعم أصيل للغة العربية**: اتجاه RTL مدمج وتوافق طباعي فاخر (خطوط Cairo وTajawal مع Inter). |
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 🔄 دورة حياة التوثيق ذات الـ 4 مراحل
|
|
43
|
+
|
|
44
|
+
تتبع المهارة مساراً تسلسلياً حتمياً من 4 مراحل:
|
|
45
|
+
|
|
46
|
+
```mermaid
|
|
47
|
+
graph LR
|
|
48
|
+
P1["1. التجهيز (Init)"] --> P2["2. الاستقراء (Collect)"]
|
|
49
|
+
P2 --> P3["3. التوليد (Generate)"]
|
|
50
|
+
P3 --> P4["4. النشر (Docsify)"]
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
[ المرحلة 1: init ] ───> إنشاء هيكل مجلد /docs وملف التتبع .doc-manifest.json
|
|
55
|
+
│
|
|
56
|
+
[ المرحلة 2: collect ] ─> استقراء الأبعاد الـ 5 (الكود، تاريخ Git، بيئة التشغيل، الجمهور، الأخطاء) وحفظها في docs/.collected/
|
|
57
|
+
│
|
|
58
|
+
[ المرحلة 3: generate ] ─> إنتاج مراجع API، الأدلة الفنية، التعليقات البرمجية، أو ملف README من الحقائق المستقرأة
|
|
59
|
+
│
|
|
60
|
+
[ المرحلة 4: docsify ] ──> تجميع index.html و_sidebar.md للعرض المباشر في المتصفح والاستضافة الثابتة
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## 🏛️ سجل الأوامر ومسارات التوثيق الأربعة
|
|
66
|
+
|
|
67
|
+
| نية المطور وطلب المستخدم | الأمر | مسارات العمل والذاكرة المحملة | المخرجات الناتجة |
|
|
68
|
+
|---|---|---|---|
|
|
69
|
+
| **"تجهيز وهيكلة مجلد التوثيق"** / "scaffold /docs" | `init` | `workflows/init-docs.md`<br>`memory/doc-tree.md` | مجلد `/docs`، ملف `docs/.doc-manifest.json`، وصفحة `docs/README.md` |
|
|
70
|
+
| **"استقراء وفحص الكود والمشروع"** / "gather facts" | `collect` | `workflows/collect.md`<br>`memory/collection-sources.md` | تقرير `docs/.collected/<target>.md` (تحليل منظم بالأبعاد الخمسة) |
|
|
71
|
+
| **"كتابة مرجع واجهة برمجة (API)"** / "API reference" | `generate` | `workflows/generate-api.md`<br>`memory/doc-templates.md`<br>`memory/stacks/*.md` | ملف `docs/api/<target>.md` (جداول المعاملات، القيم المرجعة، الأخطاء) |
|
|
72
|
+
| **"كتابة دليل إعداد وتشغيل"** / "setup guide" | `generate` | `workflows/generate-guide.md`<br>`memory/doc-templates.md` | ملف `docs/guides/<purpose-slug>.md` (دليل متخصص محدد الغرض) |
|
|
73
|
+
| **"توليد أو تحديث README الرئيسي"** / "generate readme" | `generate` | `workflows/generate-readme.md`<br>`memory/doc-templates.md` | ملف `README.md` في جذر المشروع (نظرة عامة، التثبيت، المتغيرات) |
|
|
74
|
+
| **"إضافة تعليقات برمجية للكود"** / "inline docblocks" | `generate` | `workflows/generate-inline.md`<br>`memory/stacks/*.md` | تعديل مباشر للملفات المصدرية بتعليقات PHPDoc / JSDoc / TSDoc |
|
|
75
|
+
| **"تحويل التوثيقات إلى موقع Docsify"** / "deploy portal" | `docsify` | `workflows/docsify.md`<br>`memory/docsify-config.md` | ملفات `docs/index.html` و`docs/_sidebar.md` (موقع تفاعلي متكامل) |
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 🛡️ ضمانات الأمان وحجب البيانات الحساسة
|
|
80
|
+
|
|
81
|
+
أثناء تشغيل وكلاء الذكاء الاصطناعي، قد تتسرب مفاتيح سرية أو عناوين خوادم حقيقية إلى ملفات التوثيق العامة. تفرض `tidyfactor-doc` قواعد حجب صارمة وغير قابلة للتجاوز (**القاعدة الإلزامية 6**):
|
|
82
|
+
|
|
83
|
+
| نوع البيانات الحساسة | المحظور منعه تماماً | البديل الآمن الإلزامي |
|
|
84
|
+
|---|---|---|
|
|
85
|
+
| **مفاتيح API والرموز السرية** | `sk_live_948f98a7c1b2...` | `EXAMPLE_TOKEN_1234567890ABCDEFGH` أو `YOUR_API_KEY` |
|
|
86
|
+
| **كلمات المرور وقواعد البيانات** | `RootP@ssw0rd2026!` | `your_secret_password` |
|
|
87
|
+
| **عناوين IP الخاصة بالخوادم** | `192.168.1.50`, `45.33.21.99` | `203.0.113.1` (نطاق RFC 5737 المخصص للتوثيق) |
|
|
88
|
+
| **روابط الملفات المحلية** | `file:///C:/path/to/project/...` | `./docs/guides/` أو `project-root/` |
|
|
89
|
+
| **روابط بيئة التطوير الداخلية** | `http://localhost:8080/admin` | `https://api.example.com` أو `http://localhost:PORT` |
|
|
90
|
+
| **مسارات مجلدات المستخدم** | `/home/developer/workspace/...` | `~/project` أو `/path/to/project` |
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## 🌐 معايير الروابط النسبية والتصفح النظيف
|
|
95
|
+
|
|
96
|
+
لضمان عرض التوثيق بشكل سليم على GitHub، وGitLab، وDocsify، وبرامج قراءة الماركداون، تطبق المهارة **القاعدة الإلزامية 7**:
|
|
97
|
+
|
|
98
|
+
- ❌ **منع المسارات المطلقة لمحطة العمل**: حظر تام لروابط `file:///` أو مسارات محركات الأقراص المحلية (`C:\...` أو `/Users/...`).
|
|
99
|
+
- ✅ **روابط نسبية نظيفة**: جميع الروابط الداخلية للمستندات تعتمد على المسارات النسبية القياسية (مثل `[دليل المعمارية](./guides/architecture.md)`).
|
|
100
|
+
- ✅ **توجيه مستقر ومستمر للقوائم في Docsify**: تكوين `alias: { '/.*/_sidebar.md': '/_sidebar.md' }` مع شرطة مائلة جذرية `/` لمنع اختفاء القائمة الجانبية أو ظهور أخطاء 404 في المسارات المتداخلة.
|
|
101
|
+
- ✅ **صفحات التوثيق العربية داخل المجلد الرئيسي**: حفظ النسخ العربية داخل `/docs` مباشرة (مثل `docs/README.ar.md`) دون الربط بملفات خارجية خارج نطاق `/docs`.
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## 📁 الهيكل المعياري لمجلد `/docs`
|
|
106
|
+
|
|
107
|
+
تلتزم جميع المشاريع المدارة بواسطة `tidyfactor-doc` بالهيكل النظيف الخالي من المجلدات الفارغة:
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
project-root/
|
|
111
|
+
├── README.md # نظرة عامة والبدء السريع للمشروع (الجذر)
|
|
112
|
+
└── docs/ # مجلد التوثيق الموحد
|
|
113
|
+
├── README.md # الصفحة الرئيسية لمركز التوثيق
|
|
114
|
+
├── README.ar.md # النظرة العامة بالعربية
|
|
115
|
+
├── index.html # بوابة Docsify التفاعلية
|
|
116
|
+
├── _sidebar.md # شجرة التنقل والقائمة الجانبية المولدة آلياً
|
|
117
|
+
├── .doc-manifest.json # ملف تتبع الحالة والمزامنة
|
|
118
|
+
├── .collected/ # نتائج الاستقراء والفحص الأولي (ملف وسيط)
|
|
119
|
+
│ ├── core.md
|
|
120
|
+
│ └── auth-module.md
|
|
121
|
+
├── api/ # مواصفات ومراجع واجهات البرمجة (API)
|
|
122
|
+
│ ├── authentication.md
|
|
123
|
+
│ └── billing.md
|
|
124
|
+
└── guides/ # الأدلة الفنية وأدلة المطورين والمستخدمين
|
|
125
|
+
├── architecture.md
|
|
126
|
+
├── developer-setup.md
|
|
127
|
+
└── deployment-runbook.md
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## 🚀 التثبيت والتشغيل السريع
|
|
133
|
+
|
|
134
|
+
### 1. تثبيت المهارة عبر NPM
|
|
135
|
+
لإضافة مهارة `tidyfactor-doc` إلى مشروعك أو سجل الوكلاء لديك:
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
npx @tidyfactor/cli-doc add-skill
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### 2. التوافق الشامل مع وكلاء الذكاء الاصطناعي
|
|
142
|
+
يمكنك استدعاء المهارة في بيئة التطوير المفضلة لديك:
|
|
143
|
+
|
|
144
|
+
| الوكيل أو المحرر | مثال الاستدعاء |
|
|
145
|
+
|---|---|
|
|
146
|
+
| **Google Antigravity** | `/tidyfactor-doc` أو "وثق هذا المشروع وأنشئ موقع Docsify" |
|
|
147
|
+
| **Claude Code** | `/tidyfactor-doc init` أو "Generate API docs for src/Core" |
|
|
148
|
+
| **Cursor & Windsurf** | `@tidyfactor-doc جهز مجلد التوثيق وافحص مسار الكود` |
|
|
149
|
+
| **Codex CLI** | `tidyfactor-doc generate API reference` |
|
|
150
|
+
|
|
151
|
+
### 3. المعاينة المحلية الفورية
|
|
152
|
+
لمعاينة موقع Docsify محلياً في المتصفح:
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
# باستخدام خادم PHP المدمج
|
|
156
|
+
php -S localhost:3001 -t docs
|
|
157
|
+
|
|
158
|
+
# أو باستخدام أداة Docsify CLI أو بايثون
|
|
159
|
+
npx docsify-cli serve docs
|
|
160
|
+
python -m http.server 3001 -d docs
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## 👨💻 المنظمة والتواصل والدعم
|
|
166
|
+
|
|
167
|
+
- 🌐 **الموقع الرسمي للمنظومة:** [https://tidyfactor.com/](https://tidyfactor.com/)
|
|
168
|
+
- 📚 **التوثيق الرسمي المعتمد:** [https://tidyfactor.com/documentation](https://tidyfactor.com/documentation)
|
|
169
|
+
- 🤝 **الشريك التقني الرسمي:** [وكالة الوكالة الرقمية Alwkala](https://alwkala.com/)
|
|
170
|
+
- 🐙 **منظمة GitHub الرسمية:** [github.com/TidyFactor](https://github.com/TidyFactor)
|
|
171
|
+
- 📧 **استفسارات الأعمال والشراكات:** [hello@tidyfactor.com](mailto:hello@tidyfactor.com)
|
|
172
|
+
- 📱 **واتساب:** [+20 101 665 6899](https://wa.me/201016656899)
|
|
173
|
+
- 📞 **الهاتف:** +20 101 665 6899
|
|
174
|
+
- 📍 **المقر:** القاهرة، جمهورية مصر العربية
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## 📜 الترخيص والمجتمع
|
|
179
|
+
|
|
180
|
+
مرخصة تحت رخصة **Apache License 2.0**. حقوق النشر محفوظة (c) 2026 لصالح [منظومة TidyFactor](https://tidyfactor.com) و[وكالة الوكالة الرقمية Alwkala](https://alwkala.com).
|
package/README.de.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# tidyfactor-doc `v1.3.0`
|
|
4
|
+
|
|
5
|
+
**Codebase Documentation Builder & Dual-Engine Publishing Platform (MkDocs & Docsify) für KI-Coding-Agenten**
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@tidyfactor/doc)
|
|
8
|
+
[](LICENSE)
|
|
9
|
+
|
|
10
|
+
[ 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)
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## ⚡ Schnellstart (Quickstart)
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Installation & Direktaufruf via NPX
|
|
20
|
+
npx @tidyfactor/cli-doc
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Oder direkt in Ihrem KI-Assistenten aufrufen (*Google Antigravity, Claude Code, Cursor, Codex*):
|
|
24
|
+
```text
|
|
25
|
+
/tidyfactor-doc
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 📋 Befehls- & Workflow-Matrix
|
|
31
|
+
|
|
32
|
+
| Befehl | Ziel & Ergebnis | Workflow-Referenz |
|
|
33
|
+
|---|---|---|
|
|
34
|
+
| `/init` | Inicialización de estructura de documentación | `workflows/init.md` |
|
|
35
|
+
| `/collect` | Entrevista y análisis de código fuente | `workflows/collect.md` |
|
|
36
|
+
| `/generate` | Generación de especificaciones API y READMEs | `workflows/generate.md` |
|
|
37
|
+
| `/mkdocs` | Compilación de portal estático MkDocs Material | `workflows/mkdocs.md` |
|
|
38
|
+
| `/docsify` | Despliegue de SPA ligera Docsify sin compilación | `workflows/docsify.md` |
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 📖 Vollständige Technische Dokumentation
|
|
43
|
+
|
|
44
|
+
Ausführliche Spezifikationen, Architekturguides und Tools finden Sie im [Offiziellen Technischen README auf Englisch (README.md)](README.md).
|
package/README.es.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# tidyfactor-doc `v1.3.0`
|
|
4
|
+
|
|
5
|
+
**Constructor de Documentación de Código y Motor de Publicación Dual (MkDocs & Docsify) para Agentes de IA**
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@tidyfactor/doc)
|
|
8
|
+
[](LICENSE)
|
|
9
|
+
|
|
10
|
+
[ 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)
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## ⚡ Inicio Rápido (Quickstart)
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Instalación e invocación vía NPX
|
|
20
|
+
npx @tidyfactor/cli-doc
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
O invócalo directamente dentro de tu asistente de IA (*Google Antigravity, Claude Code, Cursor, Codex*):
|
|
24
|
+
```text
|
|
25
|
+
/tidyfactor-doc
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 📋 Matriz de Comandos Principales
|
|
31
|
+
|
|
32
|
+
| Comando | Objetivo y Resultado | Flujo de Trabajo |
|
|
33
|
+
|---|---|---|
|
|
34
|
+
| `/init` | Inicialización de estructura de documentación | `workflows/init.md` |
|
|
35
|
+
| `/collect` | Entrevista y análisis de código fuente | `workflows/collect.md` |
|
|
36
|
+
| `/generate` | Generación de especificaciones API y READMEs | `workflows/generate.md` |
|
|
37
|
+
| `/mkdocs` | Compilación de portal estático MkDocs Material | `workflows/mkdocs.md` |
|
|
38
|
+
| `/docsify` | Despliegue de SPA ligera Docsify sin compilación | `workflows/docsify.md` |
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 📖 Especificación Técnica Completa
|
|
43
|
+
|
|
44
|
+
Para la arquitectura profunda, esquemas JSON y documentación de herramientas nativas, consulta el [README Técnico en Inglés (README.md)](README.md).
|
package/README.fa.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<div align="center" dir="rtl">
|
|
2
|
+
|
|
3
|
+
# tidyfactor-doc `v1.3.0`
|
|
4
|
+
|
|
5
|
+
**موتور ساخت مستندات کد و انتشار دوگانه پورتالهای مستندات (MkDocs و Docsify) برای ایجنتهای هوش مصنوعی**
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@tidyfactor/doc)
|
|
8
|
+
[](LICENSE)
|
|
9
|
+
|
|
10
|
+
[ 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)
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## ⚡ راهاندازی سریع (Quickstart)
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# نصب و اجرای مستقیم از طریق NPX
|
|
20
|
+
npx @tidyfactor/cli-doc
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
یا فراخوانی مستقیم در دستیار برنامهنویسی (*Google Antigravity, Claude Code, Cursor, Codex*):
|
|
24
|
+
```text
|
|
25
|
+
/tidyfactor-doc
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 📋 ماتریس دستورات اصلی
|
|
31
|
+
|
|
32
|
+
| دستور | هدف و نتیجه | جریان کاری (Workflow) |
|
|
33
|
+
|---|---|---|
|
|
34
|
+
| `/init` | Inicialización de estructura de documentación | `workflows/init.md` |
|
|
35
|
+
| `/collect` | Entrevista y análisis de código fuente | `workflows/collect.md` |
|
|
36
|
+
| `/generate` | Generación de especificaciones API y READMEs | `workflows/generate.md` |
|
|
37
|
+
| `/mkdocs` | Compilación de portal estático MkDocs Material | `workflows/mkdocs.md` |
|
|
38
|
+
| `/docsify` | Despliegue de SPA ligera Docsify sin compilación | `workflows/docsify.md` |
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 📖 مستندات فنی کامل و رسمی
|
|
43
|
+
|
|
44
|
+
برای دسترسی به اسکیماهای معماری، الگوهای کامل طراحی و ابزارهای بومی، به [مستندات فنی کامل به زبان انگلیسی (README.md)](README.md) مراجعه نمایید.
|
package/README.fr.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# tidyfactor-doc `v1.3.0`
|
|
4
|
+
|
|
5
|
+
**Générateur de Documentation de Codebase et Plateforme de Publication Double (MkDocs & Docsify) pour Agents d'IA**
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@tidyfactor/doc)
|
|
8
|
+
[](LICENSE)
|
|
9
|
+
|
|
10
|
+
[ 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)
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## ⚡ Démarrage Rapide (Quickstart)
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Installation et exécution via NPX
|
|
20
|
+
npx @tidyfactor/cli-doc
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Ou appelez-le directement depuis votre assistant IA (*Google Antigravity, Claude Code, Cursor, Codex*) :
|
|
24
|
+
```text
|
|
25
|
+
/tidyfactor-doc
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 📋 Matrice des Commandes Principales
|
|
31
|
+
|
|
32
|
+
| Commande | Objectif & Résultat | Référence de Workflow |
|
|
33
|
+
|---|---|---|
|
|
34
|
+
| `/init` | Inicialización de estructura de documentación | `workflows/init.md` |
|
|
35
|
+
| `/collect` | Entrevista y análisis de código fuente | `workflows/collect.md` |
|
|
36
|
+
| `/generate` | Generación de especificaciones API y READMEs | `workflows/generate.md` |
|
|
37
|
+
| `/mkdocs` | Compilación de portal estático MkDocs Material | `workflows/mkdocs.md` |
|
|
38
|
+
| `/docsify` | Despliegue de SPA ligera Docsify sin compilación | `workflows/docsify.md` |
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 📖 Documentation Technique Complète
|
|
43
|
+
|
|
44
|
+
Pour consulter l'architecture approfondie et les spécifications complètes, veuillez vous référer au [README Technique Officiel en Anglais (README.md)](README.md).
|