Wiki Workflow Guide using VS Code

🧭 Wiki Workflow Guide using VS Code

This guide outlines a structured workflow to manage and update a GitHub wiki using local editing, folder organization, sidebar generation, and automated git operations — all based on KCS (Knowledge-Centered Service) principles.

Last updated: June 27, 2025

---

🧱 1. Project Setup

✅ Requirements

• Node.js (Make sure to check “Add to PATH” during installation)
• Git installed and configured
• A local clone of your GitHub wiki repo (e.g. your-repo.wiki.git)

Clone the wiki:

git clone https://github.com/your-org/your-repo.wiki.git

---

🧩 2. Organize Wiki Pages Locally

Structure your Markdown files in meaningful folders:

📁 The-Escalation-Protocol.wiki/
├── Getting-Started/
│   └── Home.md
├── Defender for Endpoint/
│   └── Endpoint Detection and Response/
│       └── Alert Tuning/
│           └── Alert-Tuning-Quick-Start-Guide.md
...

---

⚙️ 3. Install Sidebar Generation Tool

Use markdown-file-tree, which supports folders.

Install it globally:

npm install -g markdown-file-tree

Ensure C:\Users\<your-user>\AppData\Roaming\npm is in your PATH.

---

📄 4. Generate or Update the _Sidebar.md

Run the following from the wiki root:

markdown-file-tree -f -o _Sidebar.md

This scans your folders and outputs a tree-structured sidebar markdown file.

---

📤 5. Commit and Push Changes

You can use these commands to stage, commit, and push changes:

git add .
git commit -m "Update wiki content and sidebar"
git push

---

🚀 Optional: Create a Push Script

Automate the entire process by saving this to a file named push-wiki.ps1:

markdown-file-tree -f -o _Sidebar.md
git add .
git commit -m "Update wiki content and sidebar"
git push

Then run with:

.\push-wiki.ps1

---

✅ Best Practices (KCS Aligned)

• Keep articles findable and consistent through folders.
• Use clear, concise titles for .md files.
• Document fixes, procedures, or gotchas immediately after solving them.
• Periodically regenerate the sidebar to reflect structure accurately.

---

🧠 Summary

Task	Tool/Command
Clone wiki	git clone <wiki-url>
Structure content	Folders + .md files
Generate sidebar	markdown-file-tree -f -o _Sidebar.md
Commit & push	git add . && git commit && git push

Happy documenting! 📚