refactor: Overhaul documentation structure and content

- Removed section on 'Design Principles' and corresponding files `_category_.yml`, `product.md`, and `system.md` - Adjusted position of 'Quick Start' and added new pages `create.md` and `install.md` - Renamed 'Features' section to 'Sample Scripts' and added new pages `git.md` and `refactor.md` - Adjusted position of 'Specifications', made slug name changes and renaming sections, and deleted `prompt_extension.md` - Added new section 'Featured Workflows' and included `commit.md` and `unit_tests.md` - Executed several file mode changes and sidebar position adjustments
devchat-ai · Mar 7, 2024 · 963accd · 963accd
1 parent 75bcb8f
commit 963accd
Show file tree

Hide file tree

Showing 18 changed files with 48 additions and 47 deletions.
diff --git a/docs/design/_category_.yml b/docs/design/_category_.yml
diff --git a/docs/design/product.md b/docs/design/product.md
diff --git a/docs/design/system.md b/docs/design/system.md
diff --git a/docs/quick-start/_category_.yml b/docs/quick-start/_category_.yml
@@ -1,5 +1,5 @@
 label: Quick Start
-position: 4
+position: 3
 link:
   type: generated-index
   slug: quick-start
diff --git a/docs/quick-start/create.md b/docs/quick-start/create.md
@@ -0,0 +1,6 @@
+---
+title: Create Intelligent Scripts
+sidebar_position: 2
+---
+
+# Create Intelligent Scripts
diff --git a/docs/quick-start/faq.md b/docs/quick-start/faq.md
@@ -1,6 +1,6 @@
 ---
 title: FAQ
-sidebar_position: 2
+sidebar_position: 3
 ---
 
 # Frequently Asked Questions
diff --git a/docs/quick-start/install.md b/docs/quick-start/install.md
@@ -0,0 +1,6 @@
+---
+title: Install in IDEs
+sidebar_position: 1
+---
+
+# Install in IDEs
diff --git a/docs/features/_category_.yml → docs/scripts/_category_.yml b/docs/features/_category_.yml → docs/scripts/_category_.yml
@@ -1,5 +1,5 @@
-label: Features
+label: Sample Scripts
 position: 5
 link:
   type: generated-index
-  slug: features
+  slug: scripts
diff --git a/docs/scripts/git.md b/docs/scripts/git.md
@@ -0,0 +1,6 @@
+---
+title: /git
+sidebar_position: 2
+---
+
+# `/git` Commands
diff --git a/docs/scripts/refactor.md b/docs/scripts/refactor.md
@@ -0,0 +1,6 @@
+---
+title: /refactor
+sidebar_position: 1
+---
+
+# `/refactor` Commands
diff --git a/docs/specs/_category_.yml b/docs/specs/_category_.yml
@@ -1,5 +1,5 @@
 label: Specifications
-position: 3
+position: 2
 link:
   type: generated-index
   slug: specs

diff --git a/docs/specs/chatmark.md b/docs/specs/chatmark.md
@@ -1,8 +1,7 @@
 ---
-id: chatmark
-slug: /chatmark-markdown-spec
+slug: /chatmark-markdown
 description: the DevChat Flavored Markdown
-sidebar_position: 5
+sidebar_position: 3
 ---
 
 # ChatMark: the DevChat Flavored Markdown

diff --git a/docs/specs/command.md b/docs/specs/command.md
@@ -1,5 +1,5 @@
 ---
-slug: /workflow-command-definition
+slug: /command-definition
 description: Unified definition of operations in a workflow
 sidebar_position: 2
 ---

diff --git a/docs/specs/workflow_dir.md → docs/specs/namespace.md b/docs/specs/workflow_dir.md → docs/specs/namespace.md
@@ -1,8 +1,7 @@
 ---
-id: workflow-directory
-slug: /devchat-workflow-directory
+slug: /namespace
 description: The directory that organizes workflows and commands
 sidebar_position: 1
 ---
 
-# Workflow Directory
+# Namespace
diff --git a/docs/specs/prompt_extension.md b/docs/specs/prompt_extension.md
diff --git a/docs/workflows/_category_.yml b/docs/workflows/_category_.yml
@@ -0,0 +1,5 @@
+label: Featured Workflows
+position: 4
+link:
+  type: generated-index
+  slug: workflows
diff --git a/docs/quick-start/installation.md → docs/workflows/commit.md b/docs/quick-start/installation.md → docs/workflows/commit.md
@@ -1,5 +1,6 @@
 ---
+title: /commit
 sidebar_position: 1
 ---
 
-# Installation
+# Commit
diff --git a/docs/workflows/unit_tests.md b/docs/workflows/unit_tests.md
@@ -0,0 +1,7 @@
+---
+id: unit-tests
+title: /unit_tests
+sidebar_position: 2
+---
+
+# Add Unite Tests