2025-11-01: Add Comprehensive Table of Contents to Documentation

AGENTS.md

@@ -4,6 +4,69 @@ Brief, concise history of AI-assisted development tasks.
 
 ---
 
+## 2025-11-01: Documentation Navigation Enhancement - Table of Contents
+
+**Commit:** `80aa0fa` | `continous-development` branch
+
+Added comprehensive Table of Contents (TOC) to all major documentation files to improve navigation and user experience.
+
+### Problem
+- README.md had 41+ sections but no TOC for quick navigation
+- doc/FAQ.md, doc/TROUBLESHOOTING.md, and doc/CONTRIBUTING.md had incomplete TOCs
+- doc/ARCHITECTURE.md was missing "Additional Resources" in TOC
+- Users had to scroll through lengthy documents to find relevant sections
+- Poor discoverability of available content
+- Not following documentation best practices
+
+### Solution
+Added/updated comprehensive TOCs across all documentation files:
+
+**README.md:**
+- Added new 34-line TOC with all major sections
+- Includes subsections for Prerequisites, Quick Start, Keybindings, Post-Installation, Customization
+- Properly formatted GitHub anchor links for all sections with emojis
+
+**doc/FAQ.md:**
+- Added missing "Still Have Questions?" section to TOC
+- Now complete with 9 major categories
+
+**doc/TROUBLESHOOTING.md:**
+- Added missing "Additional Documentation" section to TOC
+- Now complete with 11 major categories
+
+**doc/CONTRIBUTING.md:**
+- Added missing "Questions?" and "Recognition" sections to TOC
+- Now complete with 11 major sections
+
+**doc/ARCHITECTURE.md:**
+- Added missing "Additional Resources" section to TOC
+- Now complete with 11 major sections
+
+### Changes Made
+- ✅ README.md: Added comprehensive 34-line TOC (+34 lines)
+- ✅ doc/FAQ.md: Added 1 missing TOC entry (+1 line)
+- ✅ doc/TROUBLESHOOTING.md: Added 1 missing TOC entry (+1 line)
+- ✅ doc/CONTRIBUTING.md: Added 2 missing TOC entries (+2 lines)
+- ✅ doc/ARCHITECTURE.md: Added 1 missing TOC entry (+1 line)
+- ✅ Total changes: 5 files, +39 lines
+
+### Impact
+- **Improved navigation**: Users can jump to any section in 1 click
+- **Better discoverability**: Full content overview visible upfront
+- **Professional appearance**: Follows documentation best practices
+- **Enhanced accessibility**: Screen readers benefit from structured navigation
+- **Better SEO**: GitHub search indexes TOC links
+- **Time savings**: Reduces scrolling time for users seeking specific information
+
+### Files Modified
+- `README.md` (added comprehensive TOC)
+- `doc/FAQ.md` (completed TOC)
+- `doc/TROUBLESHOOTING.md` (completed TOC)
+- `doc/CONTRIBUTING.md` (completed TOC)
+- `doc/ARCHITECTURE.md` (completed TOC)
+
+---
+
 ## 2025-10-31: Terminal Strategy Shift - Ghostty Over tmux
 
 **Commit:** `2511c79` | `continous-development` branch

README.md

@@ -4,6 +4,40 @@
 
 Transform your coding experience with NairoVIM - a sophisticated Neovim configuration that combines the legendary efficiency of Vim with modern IDE features, AI assistance, and a beautifully integrated terminal workflow. Whether you're a seasoned developer or new to terminal-based editing, NairoVIM provides everything you need for productive development.
 
+## 📑 Table of Contents
+
+- [✨ Key Features](#-key-features)
+- [📋 Prerequisites](#-prerequisites)
+  - [System Requirements](#system-requirements)
+  - [Optional but Recommended](#optional-but-recommended)
+- [🚀 Quick Installation](#-quick-installation)
+- [🎯 Quick Start Guide](#-quick-start-guide)
+  - [Starting a Development Session](#starting-a-development-session)
+  - [Essential Workflows](#essential-workflows)
+- [⌨️ Essential Keybindings](#️-essential-keybindings)
+  - [File Navigation & Search](#file-navigation--search)
+  - [LSP & Code Intelligence](#lsp--code-intelligence)
+  - [AI Assistance (OpenCode)](#ai-assistance-opencode)
+  - [Git Integration](#git-integration)
+  - [Window Management](#window-management)
+- [🤖 AI Assistance Setup](#-ai-assistance-setup)
+  - [OpenCode - Primary AI Assistant (Recommended)](#opencode---primary-ai-assistant-recommended)
+- [🎨 Post-Installation Setup](#-post-installation-setup)
+  - [1. Configure Ghostty Terminal (Recommended)](#1-configure-ghostty-terminal-recommended)
+  - [2. Install a Nerd Font](#2-install-a-nerd-font)
+  - [3. Set Up Language Servers](#3-set-up-language-servers)
+  - [4. Configure Git](#4-configure-git)
+- [📸 Screenshots](#-screenshots)
+- [🎨 Customization](#-customization)
+  - [Change Theme](#change-theme)
+  - [Manage Plugins](#manage-plugins)
+  - [Disable Unwanted Plugins](#disable-unwanted-plugins)
+- [🆘 Troubleshooting](#-troubleshooting)
+- [📚 Documentation](#-documentation)
+- [🤝 Contributing](#-contributing)
+- [📄 License](#-license)
+- [🙏 Acknowledgments](#-acknowledgments)
+
 ## ✨ Key Features
 
 - 🤖 **AI-Powered Development** - Integrated OpenCode, Avante AI, and GitHub Copilot support

doc/ARCHITECTURE.md

@@ -14,6 +14,7 @@ Complete technical documentation for NairoVIM's architecture, plugin ecosystem,
 - [AI Tools](#ai-tools)
 - [Security Considerations](#security-considerations)
 - [Extending NairoVIM](#extending-nairovim)
+- [Additional Resources](#additional-resources)
 
 ---
 

doc/CONTRIBUTING.md

@@ -13,6 +13,8 @@ Thank you for considering contributing to NairoVIM! This document provides guide
 - [Pull Request Process](#pull-request-process)
 - [Plugin Guidelines](#plugin-guidelines)
 - [Testing](#testing)
+- [Questions?](#questions)
+- [Recognition](#recognition)
 
 ## Code of Conduct
 

doc/FAQ.md

@@ -12,6 +12,7 @@ Common questions and answers about NairoVIM installation, configuration, and usa
 - [Keybindings](#keybindings)
 - [Troubleshooting](#troubleshooting)
 - [General Questions](#general-questions)
+- [Still Have Questions?](#still-have-questions)
 
 ---
 

doc/TROUBLESHOOTING.md

@@ -14,6 +14,7 @@ Comprehensive guide to resolving common issues with NairoVIM.
 - [Keybinding Conflicts](#keybinding-conflicts)
 - [Terminal and Shell Issues](#terminal-and-shell-issues)
 - [Getting Help](#getting-help)
+- [Additional Documentation](#additional-documentation)
 
 ---