title: README

!!Table of Contents Kinetic Efficiency Nexus (Tocken)

Markdown Links act like Wikilinks

📑 AI Primary Files

• 🔹 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

🔍 Table of Contents

• [[#🎯 Project Abstract & Core Value]] ^toc-abstract
• [[#🛠️ Technology Stack at a Glance]] ^toc-stack
• [[#🗺️ Project Layout Blueprint]] ^toc-blueprint
• [[#⚡ Quick Start for AI Developers]] ^toc-quickstart
• [[#Go to...]] ^toc-goto

🎯 Project Abstract & Core Value

[[#^toc-abstract|TOC]]

• A robust Obsidian extension designed to handle fast link parsing, viewport transitions, kinetic scrolling, and non-destructive styling overlays inside CodeMirror 6 and Reading Mode markdown preview panels.

🛠️ Technology Stack at a Glance

[[#^toc-stack|TOC]]

• Target Operating System: Cross-platform (Windows, macOS, Linux, iOS, Android) running Obsidian.
• Core Languages & Runtimes: JavaScript (ES6+), Node.js.
• Integrations: Obsidian API, CodeMirror 6 View/Viewport, HTML DOM APIs.

🗺️ Project Layout Blueprint

[[#^toc-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-quickstart|TOC]]

1. Verify Environment

Verify Node.js is installed locally, then run the compilation script:

node build.js

2. Compile & Run Tests

To execute package compilation and deploy the plugin bundle to the destination Obsidian folder:

node build.js

🚀 Go to...

[[#^toc-goto|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