📚 Documentation Index

Welcome to the comprehensive documentation for OhMyPosh Atomic Enhanced. This index will help you find exactly what you need.

Quick Navigation

🚀 Getting Started

• QUICK-START-GUIDE.md - Get up and running in 5 minutes
• CROSS-PLATFORM-SETUP-GUIDE.md - Setup for Windows, macOS, and Linux
• README.md - Project overview and feature highlights

🎨 Customization & Design

• ADVANCED-CUSTOMIZATION-GUIDE.md - Deep customization and advanced features
• COLOR-THEORY-GUIDE.md - Understanding colors and creating palettes
• DIVIDERS-COLOR-TRANSITIONS-GUIDE.md - Visual separators and transitions
• GITHUB-PAGES-LIQUID.md - Prevent GitHub Pages/Jekyll from breaking on {{ ... }} template examples
• THEME-GENERATOR-README.md - Using theme generation tools

🔧 Integration & Setup

• INTEGRATION-GUIDES.md - Integrate with VS Code, Windows Terminal, WSL, etc.
• POWERSHELL-ANSI-COLOR-GUIDE.md - Understanding ANSI colors in PowerShell
• CROSS-PLATFORM-SETUP-GUIDE.md - Platform-specific setup

⚡ Optimization & Troubleshooting

• PERFORMANCE-OPTIMIZATION-GUIDE.md - Speed up your prompt
• TROUBLESHOOTING-GUIDE.md - Fix common issues
• FAQ-AND-TIPS-TRICKS.md - Answers and pro tips

📖 Reference

• QUICK-REFERENCE.md - Common commands and configurations
• Changelog - Version history and updates

---

By Use Case

“I want to get started quickly”

1. Read QUICK-START-GUIDE.md
2. Copy a theme file and initialize it
3. Done! You should see the prompt immediately

“I want to customize my theme”

1. Start with ADVANCED-CUSTOMIZATION-GUIDE.md
2. Learn about colors in COLOR-THEORY-GUIDE.md
3. Use tools in THEME-GENERATOR-README.md
4. Reference QUICK-REFERENCE.md for syntax

“My prompt is slow”

1. Check PERFORMANCE-OPTIMIZATION-GUIDE.md
2. Enable caching and disable expensive segments
3. See improvement immediately

“My prompt looks wrong”

1. Consult TROUBLESHOOTING-GUIDE.md
2. Check font, colors, and terminal settings
3. Follow troubleshooting flowchart

“I want to use this with specific tools”

1. See INTEGRATION-GUIDES.md
2. Find your tool/IDE section
3. Follow step-by-step setup

“I have a question”

1. Check FAQ-AND-TIPS-TRICKS.md
2. Search existing GitHub issues
3. Open a new issue with details

---

Documentation Structure

1. Getting Started (Beginner-Friendly)

These guides assume no prior knowledge:

• Clear, step-by-step instructions
• Common use cases covered
• Troubleshooting included
• Examples for each step

Files:

• QUICK-START-GUIDE.md
• CROSS-PLATFORM-SETUP-GUIDE.md
• INTEGRATION-GUIDES.md

2. Customization (Intermediate)

These guides assume you have the prompt working:

• How to modify segments
• Customizing colors and appearance
• Creating new themes
• Advanced formatting

Files:

• ADVANCED-CUSTOMIZATION-GUIDE.md
• COLOR-THEORY-GUIDE.md
• DIVIDERS-COLOR-TRANSITIONS-GUIDE.md
• THEME-GENERATOR-README.md
• POWERSHELL-ANSI-COLOR-GUIDE.md

3. Advanced (Expert-Level)

These guides cover complex scenarios:

• Performance tuning
• Optimization techniques
• Complex integrations
• Advanced scripting

Files:

• PERFORMANCE-OPTIMIZATION-GUIDE.md

4. Reference (For Lookup)

Quick lookup materials:

• Common problems and solutions
• Command syntax
• Configuration options
• Pro tips and tricks

Files:

• TROUBLESHOOTING-GUIDE.md
• FAQ-AND-TIPS-TRICKS.md
• QUICK-REFERENCE.md

---

Topic Coverage Matrix

Topic	Beginner	Intermediate	Advanced	Reference
Installation	✅	—	—	✅
Basic Setup	✅	✅	—	✅
Colors	—	✅	✅	—
Segments	✅	✅	✅	✅
Performance	⚠️	✅	✅	—
Customization	⚠️	✅	✅	✅
Troubleshooting	✅	✅	✅	✅
Integration	✅	✅	—	—
FAQ	✅	✅	✅	—

Key: ✅ = Comprehensive, ⚠️ = Partial coverage, — = Not covered

---

Learning Path by Goal

Goal: Beautiful Prompt in 5 Minutes

QUICK-START-GUIDE.md → Done!

Goal: Match Brand/Personal Style

QUICK-START-GUIDE.md
→ COLOR-THEORY-GUIDE.md
→ ADVANCED-CUSTOMIZATION-GUIDE.md
→ THEME-GENERATOR-README.md

Goal: Maximum Performance

PERFORMANCE-OPTIMIZATION-GUIDE.md
→ QUICK-REFERENCE.md (for syntax)
→ FAQ-AND-TIPS-TRICKS.md (for best practices)

Goal: Team/Corporate Standardization

QUICK-START-GUIDE.md
→ ADVANCED-CUSTOMIZATION-GUIDE.md
→ CROSS-PLATFORM-SETUP-GUIDE.md
→ INTEGRATION-GUIDES.md
→ PERFORMANCE-OPTIMIZATION-GUIDE.md

Goal: Full Customization Control

ADVANCED-CUSTOMIZATION-GUIDE.md
→ POWERSHELL-ANSI-COLOR-GUIDE.md
→ COLOR-THEORY-GUIDE.md
→ DIVIDERS-COLOR-TRANSITIONS-GUIDE.md
→ THEME-GENERATOR-README.md

---

Key Concepts Explained

Themes

Pre-configured sets of:

• Color palette
• Segment configuration
• Layout/structure
• Default styling

Where to learn: QUICK-START-GUIDE.md, ADVANCED-CUSTOMIZATION-GUIDE.md

Segments

Individual components of the prompt:

• Git information
• File path
• Exit status
• Time/date
• Environment variables

Where to learn: ADVANCED-CUSTOMIZATION-GUIDE.md, QUICK-REFERENCE.md

Palette

All colors used in a theme:

• Primary accent
• Status colors
• Neutral colors
• Background colors

Where to learn: COLOR-THEORY-GUIDE.md, ADVANCED-CUSTOMIZATION-GUIDE.md

Caching

Storing segment output to avoid recalculation:

• Session caching
• Folder caching
• Duration settings

Where to learn: PERFORMANCE-OPTIMIZATION-GUIDE.md

Transient Prompt

Simplified prompt shown after commands:

• Different from main prompt
• No slow segments
• More visually compact

Where to learn: ADVANCED-CUSTOMIZATION-GUIDE.md, FAQ-AND-TIPS-TRICKS.md

---

File-by-File Summary

QUICK-START-GUIDE.md

Length: ~2,000 words Level: Beginner Time to complete: 5-10 minutes Covers:

• Installation (all platforms)
• Font setup
• Theme selection
• First launch verification

CROSS-PLATFORM-SETUP-GUIDE.md

Length: ~3,000 words Level: Beginner-Intermediate Time to complete: 15-20 minutes Covers:

• Windows PowerShell setup
• macOS (Zsh/Bash) setup
• Linux (various distros) setup
• WSL2 setup
• Troubleshooting by platform

ADVANCED-CUSTOMIZATION-GUIDE.md

Length: ~5,000 words Level: Intermediate-Advanced Time to complete: 30-60 minutes Covers:

• Segment configuration
• Template syntax
• Color customization
• Creating new themes
• Advanced formatting

POWERSHELL-ANSI-COLOR-GUIDE.md

Length: ~4,000 words Level: Intermediate Time to complete: 20-30 minutes Covers:

• ANSI escape sequences
• Color models (RGB, HSL, 256-color)
• PowerShell string formatting
• Common color mistakes
• Best practices

COLOR-THEORY-GUIDE.md

Length: ~6,000 words Level: Intermediate Time to complete: 30-45 minutes Covers:

• Color theory fundamentals
• Color relationships
• Accessibility standards
• Palette design principles
• Creating custom palettes

PERFORMANCE-OPTIMIZATION-GUIDE.md

Length: ~4,000 words Level: Intermediate-Advanced Time to complete: 20-30 minutes Covers:

• Identifying bottlenecks
• Caching strategies
• Disabling expensive segments
• Benchmarking techniques
• Pre-optimized configurations

INTEGRATION-GUIDES.md

Length: ~5,000 words Level: Beginner-Intermediate Time to complete: 15-30 minutes (per tool) Covers:

• VS Code integration
• Windows Terminal setup
• Git Bash setup
• WSL setup
• macOS (iTerm2) setup
• SSH/Remote setup

TROUBLESHOOTING-GUIDE.md

Length: ~3,000 words Level: Beginner-Advanced Time to complete: 10-20 minutes (for specific issue) Covers:

• Font & glyph problems
• Color display issues
• Performance problems
• Git status issues
• Terminal emulator specific issues

FAQ-AND-TIPS-TRICKS.md

Length: ~4,000 words Level: All levels Time to complete: Variable (reference) Covers:

• Frequently asked questions
• Pro tips and tricks
• Workflow optimizations
• Common problems & solutions
• Quick reference table

THEME-GENERATOR-README.md

Length: Variable Level: Intermediate Time to complete: 10-20 minutes Covers:

• Using theme generation tools
• Generating new themes
• Modifying existing themes
• Tool-specific instructions

DIVIDERS-COLOR-TRANSITIONS-GUIDE.md

Length: Variable Level: Intermediate-Advanced Time to complete: 20-30 minutes Covers:

• Divider options
• Color transition techniques
• Visual separation methods
• Examples and templates

QUICK-REFERENCE.md

Length: ~2,000 words Level: All levels (reference) Time to complete: Variable (lookup) Covers:

• Common commands
• Configuration options
• Segment reference
• Syntax examples
• Quick snippets

---

How to Use This Documentation

Method 1: Task-Based

1. Define your task: “I want to make the prompt faster”
2. Find it in “By Use Case” section
3. Follow the suggested reading path

Method 2: Level-Based

1. Identify your skill level: Beginner/Intermediate/Advanced
2. Start with recommended beginner guides
3. Progress to more advanced guides

Method 3: Search

1. Use browser search (Ctrl+F)
2. Search for your problem/question
3. Jump to relevant section

Method 4: Reference

1. You know what you need
2. Go directly to QUICK-REFERENCE.md or FAQ
3. Find the specific answer

---

Contributing to Documentation

Found an error or want to improve docs?

1. Report issues: Open a GitHub issue with the docs tag
2. Submit improvements:
   • Fork the repository
   • Edit the markdown file
   • Submit a pull request
3. Suggest new topics:
   • Open a discussion or issue
   • Describe what’s missing
   • Suggest a title and outline

---

Documentation Maintenance

Last Updated

• Core guides: [Check repo commits]
• Examples: [Check repo commits]
• Theme-specific: [Check repo commits]

Version Compatibility

This documentation applies to:

• Oh My Posh 7.0+
• Atomic Enhanced (all versions)

Versioning

• Follow semantic versioning
• Major updates warrant new guide sections
• Breaking changes highlighted in updates

---

Quick Links

Official Resources

• Oh My Posh GitHub
• Oh My Posh Documentation
• Atomic Enhanced Repository

Helpful Tools

• Color Picker
• Nerd Fonts
• JSON Validator
• Color Theory Tool

Community

• GitHub Issues
• GitHub Discussions

---

Documentation Roadmap

✅ Completed

• Quick start guide
• Cross-platform setup
• Advanced customization
• PowerShell ANSI guide
• Color theory guide
• Performance optimization
• Integration guides
• Troubleshooting
• FAQ & tips
• This index

🔄 In Progress

• Video tutorials (planned)
• Interactive color picker (planned)
• Theme comparison tool (planned)

📋 Planned

• API documentation
• Plugin development guide
• Advanced performance tuning
• Enterprise deployment guide

---

Need Help?

Quick answers: FAQ-AND-TIPS-TRICKS.md

Can’t find your issue: TROUBLESHOOTING-GUIDE.md

Want more info: ADVANCED-CUSTOMIZATION-GUIDE.md

Still stuck: Open a GitHub Issue

---

Documentation Quality Standards

All guides follow:

• ✅ Clear structure with headers
• ✅ Table of contents
• ✅ Examples for key concepts
• ✅ Troubleshooting sections
• ✅ Links to related docs
• ✅ Beginner-friendly language
• ✅ Tested instructions
• ✅ Up-to-date information

---

Happy documenting! 📚✨

For suggestions on documentation, please open an issue with the “documentation” label.