HeadGym Pablo Writer User Guide
Table of Contents
- Introduction
- Getting Started
- Interface Overview
- Working with Documents
- AI Assistant Features
- Editor Features
- File Management
- Understanding Modes
- Tips and Best Practices
- Troubleshooting
Introduction
What is HeadGym Pablo?
HeadGym Pablo is an intelligent document editing platform that combines a powerful markdown editor with an AI assistant. It’s designed to help you create, edit, and manage technical documentation, specifications, blog posts, and other content with the assistance of AI-powered tools.
Key Features
- Intelligent Document Editor - Rich text editing with markdown support
- AI Assistant - Context-aware AI helper for writing, editing, and planning
- File Management - Organized workspace with folder structure
- Multiple AI Modes - Plan, Act, and Ask modes for different workflows
- Real-time Collaboration - Work seamlessly with AI assistance
- Export Options - Save and share your documents in various formats
Getting Started
First Steps
- Launch HeadGym Pablo - Open the application in your browser or desktop app
- Explore the Interface - Familiarize yourself with the three main panels:
- Left sidebar (File Explorer)
- Center panel (Document Editor)
- Right panel (AI Assistant)
- Create Your First Document - Click the ”+” icon in the Explorer to create a new file
- Start Writing - Begin typing in the editor or ask the AI assistant for help
System Requirements
- Modern web browser (Chrome, Firefox, Safari, Edge)
- Internet connection for AI features
- Recommended: 8GB RAM, modern processor
Interface Overview
Main Components
1. Left Sidebar - Navigation Panel
The left sidebar contains several key navigation tools:
- Explorer Icon (📄) - Access your file tree and workspace
- Tag/Label Icon (🏷️) - Manage document tags and categories
- Globe Icon (🌐) - Web resources and links
- Box Icon (📦) - Project resources
- Puzzle Icon (🧩) - Extensions and plugins
- List Icon (📋) - Document outline and structure
- Camera Icon (📷) - Media and image management
- Microphone Icon (🎤) - Voice input features
- Chat Icon (💬) - AI conversation history
- Theme Toggle (🌙) - Switch between light and dark mode
- Settings Icon (⚙️) - Application preferences
2. File Explorer Panel
Located at the top of the left sidebar when Explorer is active:
-
EXPLORER header with controls:
- + - Create new file
- ↻ - Refresh file tree
- 📁 - Create new folder
- 📋 - Copy file path
- 📄 - Duplicate file
-
Folder Tree - Hierarchical view of your workspace:
- Click arrows (▶) to expand/collapse folders
- Click file names to open documents
- Right-click for context menu options
3. Document Editor (Center Panel)
The main editing area features:
Top Toolbar with formatting options:
- B - Bold text
- I - Italic text
- ‘‘- Code/monospace
- 🔍 - Search in document
- 🔗 - Insert link
- 🖼️ - Insert image
- H₁ - Heading 1
- H₂ - Heading 2
- ⋮⋮ - Numbered list
- - Code block
- ≡ - Bullet list
- ≣ - Ordered list
- ↶ - Undo
- ↷ - Redo
- ⇥ - Indent
- ⇤ - Outdent
- — - Horizontal rule
- ⊞ - Insert table
Editor Area:
- Full markdown support
- Real-time preview
- Syntax highlighting
- Auto-save functionality
Status Bar:
- File path display
- Word count
- Character count
4. AI Assistant Panel (Right Side)
The AI chat interface includes:
- “How can I help you?” header with robot icon
- Chat History - Scrollable conversation area
- Message Input Box - “Type a message…” field
- Action Buttons:
- Add Context - Include additional files or information
- Page.mdx - Current document context indicator
- Attachment (📎) - Attach files
- Settings (⚙️) - AI preferences
- + - Additional options
Mode Selectors (Bottom):
- Plan Mode dropdown - Select AI operation mode
- Gemini Pro dropdown - Choose AI model
- Send button (▶) - Submit your message
Working with Documents
Creating New Documents
-
Using the Explorer:
- Click the + icon next to “EXPLORER”
- Enter a filename (include .mdx or .md extension)
- Press Enter to create
-
Using Keyboard Shortcut:
- Press
Cmd/Ctrl + Nfor new file
- Press
Opening Documents
- Click any file in the Explorer tree
- Use
Cmd/Ctrl + Pfor quick file search - Recent files appear at the top of the Explorer
Saving Documents
- Auto-save - Documents save automatically as you type
- Manual Save - Press
Cmd/Ctrl + Sto force save - Save indicator appears in the status bar
Organizing Documents
-
Create Folders:
- Click the folder icon in Explorer
- Name your folder
- Drag files into folders
-
Move Files:
- Drag and drop files between folders
- Right-click for “Move to…” option
-
Rename Files:
- Right-click file → Rename
- Or click file name slowly twice
-
Delete Files:
- Right-click file → Delete
- Or select file and press Delete key
AI Assistant Features
How to Use the AI Assistant
The AI assistant is your intelligent partner for document creation and editing. Here’s how to interact with it:
Starting a Conversation
- Type Your Request in the message box
- Add Context if needed (click “Add Context” button)
- Select Mode (Plan, Act, or Ask)
- Click Send or press Enter
Types of Requests
Writing Assistance:
- “Write an introduction about [topic]”
- “Improve this paragraph”
- “Make this more professional”
Editing Tasks:
- “Fix grammar and spelling”
- “Shorten this section”
- “Expand on this idea”
Content Creation:
- “Create a table comparing [items]”
- “Generate a list of [items]”
- “Write a conclusion”
Planning:
- “Help me outline a user guide”
- “What sections should I include?”
- “Review my document structure”
Adding Context
The AI works better with context. Add context by:
- Clicking “Add Context” button
- Selecting relevant files from your workspace
- The AI will read and understand those files
- Context appears as tags (e.g., “page.mdx”)
AI Responses
The AI can:
- Write directly to your document
- Suggest changes for you to approve
- Answer questions about your content
- Create plans before implementing changes
File Management
Workspace Organization
Folder Structure Best Practices
workspace/
├── about/
├── ai-glossary/
├── blog/
├── use-case-demos/
│ └── software-specifications/
├── techblog/
└── the_pablo_ui/Tips:
- Group related documents in folders
- Use clear, descriptive folder names
- Keep folder depth reasonable (3-4 levels max)
- Create a consistent naming convention
File Naming Conventions
Good Examples:
user-guide.mdxapi-documentation.md2024-01-15-blog-post.mdx
Avoid:
- Spaces in filenames
- Special characters (except hyphens and underscores)
- Very long names
File Types
HeadGym Pablo supports:
- .mdx - MDX files (Markdown + JSX)
- .md - Standard Markdown
- .txt - Plain text
- .jsx - React components
- .css - Stylesheets
Understanding Modes
HeadGym Pablo operates in three distinct AI modes, each designed for different workflows:
Plan Mode
Purpose: Planning and strategizing before taking action
When to Use:
- Starting a new document or project
- Need to brainstorm ideas
- Want to outline before writing
- Require detailed planning
How It Works:
- Select “Plan Mode” from the dropdown
- Discuss your goals with the AI
- AI helps you create a structured plan
- Review and refine the plan
- Switch to Act Mode to implement
Example Requests:
- “Help me plan a user guide for a mobile app”
- “What sections should I include in a technical specification?”
- “Outline a blog post about AI trends”
Act Mode
Purpose: Executing tasks and making changes to documents
When to Use:
- Implementing an approved plan
- Making edits to existing content
- Creating new content
- Performing document operations
How It Works:
- Select “Act Mode” from the dropdown
- Give specific instructions
- AI performs actions (writes, edits, creates files)
- Review the changes
- Iterate as needed
Example Requests:
- “Write the introduction section”
- “Create a new file called api-reference.mdx”
- “Fix the formatting in this table”
- “Add code examples to this section”
Ask Mode
Purpose: Getting information and answers without making changes
When to Use:
- Have questions about your content
- Need clarification or explanations
- Want to learn about a topic
- Seeking general assistance
Ask Mode
Purpose: Getting information and answers without making changes
When to Use:
- Have questions about your content
- Need clarification or explanations
- Want to learn about a topic
- Seeking general assistance
How It Works:
- Select “Ask Mode” from the dropdown
- Ask your question
- AI provides information and answers
- No changes are made to documents
Example Requests:
- “What is the difference between .md and .mdx files?”
- “Explain this code snippet”
- “What are best practices for API documentation?”
- “How do I structure a technical guide?”
Switching Between Modes
When to Switch:
- Plan → Act: After finalizing your plan and ready to implement
- Act → Plan: When you need to reconsider your approach
- Any → Ask: When you have questions or need information
- Ask → Plan/Act: When ready to take action based on answers
How to Switch: Simply select the desired mode from the dropdown at the bottom of the AI panel.
Tips and Best Practices
Writing Efficiently
-
Use Keyboard Shortcuts
Cmd/Ctrl + B- BoldCmd/Ctrl + I- ItalicCmd/Ctrl + K- Insert linkCmd/Ctrl + S- SaveCmd/Ctrl + F- SearchCmd/Ctrl + Z- UndoCmd/Ctrl + Shift + Z- Redo
-
Leverage AI Assistance
- Start with Plan Mode for structure
- Use Act Mode for implementation
- Ask Mode for quick questions
- Add context for better results
-
Organize Your Workspace
- Create logical folder structures
- Use consistent naming conventions
- Keep related files together
- Archive old projects
Working with the AI
Be Specific: ❌ “Make this better” ✅ “Make this introduction more engaging and add a hook”
Provide Context: ❌ “Write about authentication” ✅ “Write about OAuth 2.0 authentication for a REST API, targeting developers”
Break Down Complex Tasks: ❌ “Create a complete user guide” ✅ “First, outline the user guide structure. Then we’ll write each section.”
Review AI Output:
- Always read what the AI generates
- Verify technical accuracy
- Adjust tone and style as needed
- Provide feedback for improvements
Document Quality
-
Structure
- Use clear headings hierarchy
- Add table of contents for long documents
- Break content into digestible sections
- Use lists for better readability
-
Formatting
- Be consistent with formatting choices
- Use code blocks for code examples
- Add images and diagrams where helpful
- Use tables for comparative information
-
Content
- Write clear, concise sentences
- Define technical terms
- Provide examples
- Include practical use cases
Troubleshooting
Common Issues and Solutions
AI Not Responding
Problem: AI assistant doesn’t respond to messages
Solutions:
- Check your internet connection
- Refresh the page
- Verify you’ve selected a mode (Plan/Act/Ask)
- Try rephrasing your request
- Check if context files are accessible
File Not Saving
Problem: Changes aren’t being saved
Solutions:
- Check for error messages in status bar
- Ensure you have write permissions
- Try manual save (Cmd/Ctrl + S)
- Check available disk space
- Refresh and try again
Formatting Issues
Problem: Markdown not rendering correctly
Solutions:
- Check markdown syntax
- Ensure proper spacing around elements
- Verify code block formatting (triple backticks)
- Check for unclosed tags or brackets
- Review in preview mode
AI Producing Incorrect Content
Problem: AI generates inaccurate or irrelevant content
Solutions:
- Provide more specific instructions
- Add relevant context files
- Break request into smaller steps
- Use Plan Mode first to clarify approach
- Provide examples of desired output
Performance Issues
Problem: Application running slowly
Solutions:
- Close unused files
- Clear browser cache
- Reduce number of open folders
- Check system resources
- Update to latest version
Getting Help
If you continue to experience issues:
- Check Documentation - Review this user guide thoroughly
- Search Community Forums - Look for similar issues
- Contact Support - Reach out to the HeadGym Pablo support team
- Report Bugs - Submit detailed bug reports with:
- Steps to reproduce
- Expected vs actual behavior
- Screenshots if applicable
- Browser/system information
Keyboard Shortcuts Reference
TBD
Frequently Asked Questions
General Questions
Q: What file formats does HeadGym Pablo support? A: HeadGym Pablo primarily supports Markdown (.md) and MDX (.mdx) files. It also works with plain text (.txt), JSX (.jsx), and CSS (.css) files.
Q: Is my data saved automatically? A: Yes, HeadGym Pablo features auto-save functionality. Your changes are saved automatically as you type. You can also manually save using Cmd/Ctrl + S.
Q: Can I work offline? A: The document editor works offline, but AI features require an internet connection to function.
Q: How do I export my documents? A: You can copy content directly from the editor, or use your browser’s save functionality. Documents are stored in standard markdown format for easy portability.
AI Assistant Questions
Q: Which AI model should I use? A: The model dropdown (e.g., “Gemini Pro”) allows you to select different AI models. Choose based on your needs:
- Standard models for general writing
- Advanced models for complex technical content
- Experiment to find what works best for your use case
Q: How much context can I provide to the AI? A: You can add multiple files as context. The AI will read and understand them to provide more relevant assistance. However, very large amounts of context may affect response time.
Q: Can the AI make mistakes? A: Yes, AI assistants can sometimes produce inaccurate or incomplete information. Always review and verify the content, especially for technical or critical information.
Q: How do I get better results from the AI? A:
- Be specific in your requests
- Provide relevant context
- Use the appropriate mode (Plan/Act/Ask)
- Break complex tasks into smaller steps
- Give feedback and iterate
Technical Questions
Q: What is the difference between .md and .mdx files? A:
- .md files are standard Markdown files
- .mdx files are Markdown with JSX support, allowing you to embed React components
Q: Can I use custom themes? A: Yes, use the theme toggle (🌙) to switch between light and dark modes. Additional customization may be available in Settings.
Q: How do I collaborate with others? A: HeadGym Pablo is primarily a single-user editor with AI assistance. For collaboration, consider using version control (Git) or sharing exported files.
Q: What are the system requirements? A:
- Modern web browser (Chrome, Firefox, Safari, Edge - latest versions)
- Internet connection for AI features
- Recommended: 8GB RAM, modern processor
- Works on Windows, macOS, and Linux
Glossary
Act Mode - AI operation mode for executing tasks and making changes to documents
AI Assistant - The intelligent helper that can write, edit, and provide guidance on your documents
Context - Additional files or information provided to the AI to improve its understanding and responses
Explorer - The file navigation panel showing your workspace folder structure
Markdown - A lightweight markup language for formatting plain text
MDX - Markdown with JSX support, allowing React components in markdown files
Plan Mode - AI operation mode for planning and strategizing before taking action
Ask Mode - AI operation mode for asking questions and getting information without making changes
Toolbar - The formatting bar at the top of the editor with various text formatting options
Workspace - Your collection of folders and files in HeadGym Pablo
Additional Resources
- Markdown Guide - markdownguide.org
- MDX Documentation - mdxjs.com
- Keyboard Shortcuts - See Troubleshooting section above
- Community Forums - Check HeadGym Pablo community for tips and tricks
Conclusion
HeadGym Pablo combines the simplicity of markdown editing with the power of AI assistance to create a unique document editing experience. Whether you’re writing technical documentation, blog posts, or planning complex projects, the combination of intelligent modes and intuitive editing tools helps you work more efficiently.
Key Takeaways
- Master the Modes - Understand when to use Plan, Act, and Ask modes
- Organize Your Workspace - Keep files and folders well-structured
- Leverage AI Effectively - Provide context and be specific in requests
- Learn Markdown - Familiarize yourself with markdown syntax
- Practice and Iterate - The more you use it, the more efficient you’ll become
Next Steps
- Create your first document
- Experiment with different AI modes
- Explore the toolbar and formatting options
- Set up your ideal workspace structure
- Share your creations!
Version: 1.0 Last Updated: December 30, 2024 For Support: Contact HeadGym Pablo support team