2025-10-31: Documentation Restructuring & Ghostty Terminal Integration #66
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 8 commits
October 31, 2025 18:56
…in ecosystem - Add complete keybinding reference section with 70+ mappings organized into 8 categories - Add plugin ecosystem section documenting all 70+ plugins across 11 functional categories - Remove duplicate Essential Shortcuts section (51 lines) - Remove nvim-ide references from keybinding tables (plugin no longer in config) - Improve navigation with detailed mode, description, and plugin attribution - Organize AI tools (Avante, Copilot, OpenCode) with usage examples and key features
- Streamline README to ~400 lines (user-focused) - Create ARCHITECTURE.md for technical details (664 lines) - Create TROUBLESHOOTING.md for issue resolution (922 lines) - Create FAQ.md with 40+ common Q&As (479 lines) - Update CONTRIBUTING.md cross-references - Update AGENTS.md with restructuring details
- Move TROUBLESHOOTING.md to doc/ directory (completes doc restructuring) - Update all README.md references to point to doc/ directory - All documentation now organized in doc/ directory: - ARCHITECTURE.md - CONTRIBUTING.md - FAQ.md - TROUBLESHOOTING.md
- Update entry status from 'pending commit' to completed with commit hashes - Add doc/ prefix to all file paths in Files Modified/Created section - Add 'Organized doc/ directory' to Changes Made - Update file sizes to match actual committed files - Add 'Moved all documentation files to doc/ directory' to changes
- Position Ghostty as recommended terminal throughout all documentation - Relegate tmux to legacy/remote-only use case with clear guidance - Add comprehensive Ghostty setup, keybindings, and troubleshooting docs - Include Ghostty vs tmux comparison table in ARCHITECTURE.md - Update FAQ with Ghostty workflows and terminal choice guidance - Add dedicated Ghostty troubleshooting section with config and split issues - Update README prerequisites, installation, quick start, and post-install setup - Maintain backward compatibility by keeping tmux documentation
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR implements a comprehensive documentation overhaul with two major improvements: (1) restructuring documentation into specialized files with clear separation of concerns, and (2) modernizing the terminal workflow by positioning Ghostty as the recommended terminal for local development.
Documentation Restructuring
Ghostty Terminal Integration
Changes Made
Why is it needed?
Documentation Issues:
Terminal Workflow Issues:
How have the changes been tested?
Screenshots (if applicable)
N/A - Documentation changes only
Checklist