title: README

README

🔍 Table of Contents

• README ^toc-readme
  • 📑 AI Primary Files ^toc-aiprimaryfiles
  • 🎯 Project Abstract & Core Value ^toc-projectabstractcorevalue
  • 🛠 Technology Stack at a Glance ^toc-technologystackataglance
  • 🗺 Project Layout Blueprint ^toc-projectlayoutblueprint
  • ⚡ Quick Start for AI Developers ^toc-quickstartforaidevelopers
    • 1. Verify Environment ^toc-1verifyenvironment
    • 2. Compile & Run Tests ^toc-2compileruntests
  • 🚀 Go to... ^toc-goto

TOC

📑 AI Primary Files

TOC

• 🔹 AGENTS.md
• 🔹 ARCHIVE.md
• 🔹 BUILD.md
• 🔹 CODE.md
• 🔹 DESIGN.md
• 🔹 FEATURES.md
• 🔹 LOG.md
• 🔹 MANUAL.md
• 🔸 README.md
• 🔹 SPEC.md
• 🔹 TASKS.md
• 🔹 TERMS.md
• 🔹 TESTING.md
• 🔹 VERSIONS.md

🎯 Project Abstract & Core Value

TOC

• An elegant Obsidian plugin that dynamically maps a chronological HSL color spectrum across all links based on their first letter's alphabetical position, featuring a smooth 360-degree rainbow rotation on user hover states.

🛠 Technology Stack at a Glance

TOC

• Target Operating System: Cross-platform (Windows, macOS, Linux, iOS, Android)
• Core Languages & Runtimes: JavaScript (ES6+), Node.js, Obsidian Plugin API v1.5.0+
• Integrations: Obsidian Extension Architecture, CodeMirror 6 Editor DOM Tree Elements

🗺 Project Layout Blueprint

TOC

• AGENTS.md ➔ System prompts and operational boundaries for AI teammates.
• AIMD/ARCHIVE.md ➔ Scriptorium for scrapped ideas and sunset components.
• AIMD/BUILD.md ➔ Compiler pipelines, flags, and packaging steps.
• AIMD/CODE.md ➔ Syntax style guidelines and error-handling mandates.
• AIMD/DESIGN.md ➔ Structural topology, design patterns, and data flows.
• AIMD/FEATURES.md ➔ Capability matrices and functional product roadmap.
• AIMD/LOG.md ➔ Chronological audit trail of development decisions.
• AIMD/MANUAL.md ➔ Installation, user runbooks, and diagnostic workflows.
• README.md ➔ Primary entry point and structural system abstract.
• AIMD/SPEC.md ➔ Technical constraints, parameters, and protocol definitions.
• AIMD/TASKS.md ➔ Dynamic task board and backlog management queue.
• AIMD/TERMS.md ➔ Technical glossary, definitions, and vocabulary indexes.
• AIMD/TESTING.md ➔ Automation suites, edge cases, and QA assertion routines.
• AIMD/VERSIONS.md ➔ Change trackers and version milestone evolution lists.

⚡ Quick Start for AI Developers

TOC

1. Verify Environment

TOC

node -v && npm -v

2. Compile & Run Tests

TOC

npm install && npm run dev

🚀 Go to...

TOC

• 🔹 AGENTS.md
• 🔹 ARCHIVE.md
• 🔹 BUILD.md
• 🔹 CODE.md
• 🔹 DESIGN.md
• 🔹 FEATURES.md
• 🔹 LOG.md
• 🔹 MANUAL.md
• 🔸 README.md
• 🔹 SPEC.md
• 🔹 TASKS.md
• 🔹 TERMS.md
• 🔹 TESTING.md
• 🔹 VERSIONS.md