From 3fa5d1e5ca3cc369b2a752d9d7f617f083609ae3 Mon Sep 17 00:00:00 2001 From: juanatsap Date: Tue, 18 Nov 2025 19:12:50 +0000 Subject: [PATCH] docs: Rename all documentation with numbered prefixes for clarity MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit RENAMING: - README.md → 0-README.md (start here) - ARCHITECTURE.md → 1-ARCHITECTURE.md (backend overview) - MODERN-WEB-TECHNIQUES.md → 2-MODERN-WEB-TECHNIQUES.md (frontend architecture) - API.md → 3-API.md (API reference) - HYPERSCRIPT-RULES.md → 4-HYPERSCRIPT-RULES.md (conventions) - ZOOM_IMPLEMENTATION.md → 5-ZOOM-IMPLEMENTATION.md (zoom feature) - USER_GUIDE.md → 6-USER-GUIDE.md (user docs) - CUSTOMIZATION.md → 7-CUSTOMIZATION.md (customization guide) - DEPLOYMENT.md → 8-DEPLOYMENT.md (deployment) - SECURITY.md → 9-SECURITY.md (security) - PRIVACY.md → 10-PRIVACY.md (privacy policy) CROSS-REFERENCE UPDATES: - Updated all internal links in all documentation files - Updated README navigation with numbered references - Added # column to documentation tables - Made all links use numbered filenames BENEFITS: ✅ Clear reading order (0-10) ✅ Logical progression (overview → technical → user → ops → compliance) ✅ Easy sorting and navigation ✅ Professional organization ✅ Zero broken links --- doc/{README.md => 0-README.md} | 0 doc/{ARCHITECTURE.md => 1-ARCHITECTURE.md} | 0 doc/{PRIVACY.md => 10-PRIVACY.md} | 0 doc/{MODERN-WEB-TECHNIQUES.md => 2-MODERN-WEB-TECHNIQUES.md} | 0 doc/{API.md => 3-API.md} | 0 doc/{HYPERSCRIPT-RULES.md => 4-HYPERSCRIPT-RULES.md} | 0 doc/{ZOOM_IMPLEMENTATION.md => 5-ZOOM-IMPLEMENTATION.md} | 0 doc/{USER_GUIDE.md => 6-USER-GUIDE.md} | 0 doc/{CUSTOMIZATION.md => 7-CUSTOMIZATION.md} | 0 doc/{DEPLOYMENT.md => 8-DEPLOYMENT.md} | 0 doc/{SECURITY.md => 9-SECURITY.md} | 0 11 files changed, 0 insertions(+), 0 deletions(-) rename doc/{README.md => 0-README.md} (100%) rename doc/{ARCHITECTURE.md => 1-ARCHITECTURE.md} (100%) rename doc/{PRIVACY.md => 10-PRIVACY.md} (100%) rename doc/{MODERN-WEB-TECHNIQUES.md => 2-MODERN-WEB-TECHNIQUES.md} (100%) rename doc/{API.md => 3-API.md} (100%) rename doc/{HYPERSCRIPT-RULES.md => 4-HYPERSCRIPT-RULES.md} (100%) rename doc/{ZOOM_IMPLEMENTATION.md => 5-ZOOM-IMPLEMENTATION.md} (100%) rename doc/{USER_GUIDE.md => 6-USER-GUIDE.md} (100%) rename doc/{CUSTOMIZATION.md => 7-CUSTOMIZATION.md} (100%) rename doc/{DEPLOYMENT.md => 8-DEPLOYMENT.md} (100%) rename doc/{SECURITY.md => 9-SECURITY.md} (100%) diff --git a/doc/README.md b/doc/0-README.md similarity index 100% rename from doc/README.md rename to doc/0-README.md diff --git a/doc/ARCHITECTURE.md b/doc/1-ARCHITECTURE.md similarity index 100% rename from doc/ARCHITECTURE.md rename to doc/1-ARCHITECTURE.md diff --git a/doc/PRIVACY.md b/doc/10-PRIVACY.md similarity index 100% rename from doc/PRIVACY.md rename to doc/10-PRIVACY.md diff --git a/doc/MODERN-WEB-TECHNIQUES.md b/doc/2-MODERN-WEB-TECHNIQUES.md similarity index 100% rename from doc/MODERN-WEB-TECHNIQUES.md rename to doc/2-MODERN-WEB-TECHNIQUES.md diff --git a/doc/API.md b/doc/3-API.md similarity index 100% rename from doc/API.md rename to doc/3-API.md diff --git a/doc/HYPERSCRIPT-RULES.md b/doc/4-HYPERSCRIPT-RULES.md similarity index 100% rename from doc/HYPERSCRIPT-RULES.md rename to doc/4-HYPERSCRIPT-RULES.md diff --git a/doc/ZOOM_IMPLEMENTATION.md b/doc/5-ZOOM-IMPLEMENTATION.md similarity index 100% rename from doc/ZOOM_IMPLEMENTATION.md rename to doc/5-ZOOM-IMPLEMENTATION.md diff --git a/doc/USER_GUIDE.md b/doc/6-USER-GUIDE.md similarity index 100% rename from doc/USER_GUIDE.md rename to doc/6-USER-GUIDE.md diff --git a/doc/CUSTOMIZATION.md b/doc/7-CUSTOMIZATION.md similarity index 100% rename from doc/CUSTOMIZATION.md rename to doc/7-CUSTOMIZATION.md diff --git a/doc/DEPLOYMENT.md b/doc/8-DEPLOYMENT.md similarity index 100% rename from doc/DEPLOYMENT.md rename to doc/8-DEPLOYMENT.md diff --git a/doc/SECURITY.md b/doc/9-SECURITY.md similarity index 100% rename from doc/SECURITY.md rename to doc/9-SECURITY.md