Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
architecture
architecture
 
 
design
design
 
 
legacy-notes
legacy-notes
 
 
ACTIONABLE_TOOL_TRUNCATION.md
ACTIONABLE_TOOL_TRUNCATION.md
 
 
ACTUAL_CONTEXT_TOKEN_TRACKING.md
ACTUAL_CONTEXT_TOKEN_TRACKING.md
 
 
ACTUAL_CONTEXT_TOKEN_TRACKING_QUICK_REF.md
ACTUAL_CONTEXT_TOKEN_TRACKING_QUICK_REF.md
 
 
ADAPTIVE_TRUNCATION.md
ADAPTIVE_TRUNCATION.md
 
 
AGENTS_PAGE_IMPROVEMENTS.md
AGENTS_PAGE_IMPROVEMENTS.md
 
 
AGENTS_PAGE_REDESIGN.md
AGENTS_PAGE_REDESIGN.md
 
 
AGENTS_PAGE_V1_V2_GAPS.md
AGENTS_PAGE_V1_V2_GAPS.md
 
 
AGENT_DATA_DISCOVERY.md
AGENT_DATA_DISCOVERY.md
 
 
AGENT_HALLUCINATION_FIX.md
AGENT_HALLUCINATION_FIX.md
 
 
AGENT_JOB_LOG_BROADCAST_FIX.md
AGENT_JOB_LOG_BROADCAST_FIX.md
 
 
AGENT_JOB_MODEL_OVERRIDE_FIX.md
AGENT_JOB_MODEL_OVERRIDE_FIX.md
 
 
AGENT_JOB_OUTPUT_IMPLEMENTATION.md
AGENT_JOB_OUTPUT_IMPLEMENTATION.md
 
 
AGENT_JOB_STRUCTURED_LOGGING.md
AGENT_JOB_STRUCTURED_LOGGING.md
 
 
AGENT_JOB_TOOL_ACCESS.md
AGENT_JOB_TOOL_ACCESS.md
 
 
AGENT_MODEL_AWARENESS.md
AGENT_MODEL_AWARENESS.md
 
 
AGENT_PERFORMANCE_TESTING.md
AGENT_PERFORMANCE_TESTING.md
 
 
AGENT_TIMEOUT_BEHAVIOR.md
AGENT_TIMEOUT_BEHAVIOR.md
 
 
AGENT_TRACKING_BUG_FOUND.md
AGENT_TRACKING_BUG_FOUND.md
 
 
AGENT_TRACKING_MANUAL_TESTS.md
AGENT_TRACKING_MANUAL_TESTS.md
 
 
AGENT_TRACKING_TEST_FINAL.md
AGENT_TRACKING_TEST_FINAL.md
 
 
AGENT_TRACKING_TEST_RESULTS.md
AGENT_TRACKING_TEST_RESULTS.md
 
 
AGENT_TRACKING_VERIFICATION_RESULTS.md
AGENT_TRACKING_VERIFICATION_RESULTS.md
 
 
AMPLITUDE_ENHANCED_TRACKING.md
AMPLITUDE_ENHANCED_TRACKING.md
 
 
AMPLITUDE_EVENTS_ONLY_SUMMARY.md
AMPLITUDE_EVENTS_ONLY_SUMMARY.md
 
 
AMPLITUDE_IMPLEMENTATION_GUIDE.md
AMPLITUDE_IMPLEMENTATION_GUIDE.md
 
 
AMPLITUDE_QUICK_REFERENCE.md
AMPLITUDE_QUICK_REFERENCE.md
 
 
AMPLITUDE_READY_TO_IMPLEMENT.md
AMPLITUDE_READY_TO_IMPLEMENT.md
 
 
AMPLITUDE_REMOVING_NOISY_EVENTS.md
AMPLITUDE_REMOVING_NOISY_EVENTS.md
 
 
AMPLITUDE_SESSION_REPLAY_SETUP.md
AMPLITUDE_SESSION_REPLAY_SETUP.md
 
 
API_KEY_WORKFLOW_FIX.md
API_KEY_WORKFLOW_FIX.md
 
 
APP_AGENT_CHAT.md
APP_AGENT_CHAT.md
 
 
APP_AGENT_GATEWAY_WARM_SPEC.md
APP_AGENT_GATEWAY_WARM_SPEC.md
 
 
APP_ICON_VALIDATION_FIX.md
APP_ICON_VALIDATION_FIX.md
 
 
APP_QUIT_BEHAVIOR_FIX.md
APP_QUIT_BEHAVIOR_FIX.md
 
 
APP_VERSION_AND_UPDATES.md
APP_VERSION_AND_UPDATES.md
 
 
ARCHITECTURE_AUDIT_2026-02-12.md
ARCHITECTURE_AUDIT_2026-02-12.md
 
 
ARTIFACTS_UI_IMPROVEMENTS.md
ARTIFACTS_UI_IMPROVEMENTS.md
 
 
AUTH0_DOUBLE_HTTPS_AND_AUTHWALL_DESIGN_FIX.md
AUTH0_DOUBLE_HTTPS_AND_AUTHWALL_DESIGN_FIX.md
 
 
AUTHWALL_CSS_VARIABLES.md
AUTHWALL_CSS_VARIABLES.md
 
 
AUTH_WALL_IMPLEMENTATION.md
AUTH_WALL_IMPLEMENTATION.md
 
 
AUTOMATED_CLAUDE_OAUTH.md
AUTOMATED_CLAUDE_OAUTH.md
 
 
AUTOMATIC_DATA_SOURCE_DISCOVERY.md
AUTOMATIC_DATA_SOURCE_DISCOVERY.md
 
 
AUTOMATIC_HYBRID_CODE_SEARCH.md
AUTOMATIC_HYBRID_CODE_SEARCH.md
 
 
AUTOMATIC_HYBRID_CODE_SEARCH_SUMMARY.md
AUTOMATIC_HYBRID_CODE_SEARCH_SUMMARY.md
 
 
AUTOMATIC_KEY_SUBSTITUTION.md
AUTOMATIC_KEY_SUBSTITUTION.md
 
 
AUTO_CLEANUP_ORPHANED_GATEWAY.md
AUTO_CLEANUP_ORPHANED_GATEWAY.md
 
 
AUTO_INSTALL_PACKAGES.md
AUTO_INSTALL_PACKAGES.md
 
 
AUTO_LAUNCH_POST_INSTALL.md
AUTO_LAUNCH_POST_INSTALL.md
 
 
AUTO_SCROLL_BEHAVIOR.md
AUTO_SCROLL_BEHAVIOR.md
 
 
AUTO_UPDATE_INSTALLER_FIX.md
AUTO_UPDATE_INSTALLER_FIX.md
 
 
BASH_CUSTOM_KEYS_IMPLEMENTATION.md
BASH_CUSTOM_KEYS_IMPLEMENTATION.md
 
 
BASH_TOOL_CUSTOM_KEYS_FIX.md
BASH_TOOL_CUSTOM_KEYS_FIX.md
 
 
BASH_TOOL_FIX.md
BASH_TOOL_FIX.md
 
 
BRIEF_PASSIVE_DISCOVERY.md
BRIEF_PASSIVE_DISCOVERY.md
 
 
BROWSER_PARSE_HTML_PERFORMANCE_FIX.md
BROWSER_PARSE_HTML_PERFORMANCE_FIX.md
 
 
BROWSER_TOOLS_PHASE_1.md
BROWSER_TOOLS_PHASE_1.md
 
 
BUNDLE_SIZE_OPTIMIZATION.md
BUNDLE_SIZE_OPTIMIZATION.md
 
 
CHATGPT_CONVERSATIONS_API.md
CHATGPT_CONVERSATIONS_API.md
 
 
CHATGPT_CONV_HISTORY_IMPLEMENTATION.md
CHATGPT_CONV_HISTORY_IMPLEMENTATION.md
 
 
CHAT_LIST_AUTO_UPDATE_FIX.md
CHAT_LIST_AUTO_UPDATE_FIX.md
 
 
CHAT_METADATA_SYNC_TEST.md
CHAT_METADATA_SYNC_TEST.md
 
 
CHAT_PAGINATION.md
CHAT_PAGINATION.md
 
 
CLAUDE_CLI_CURL_INSTALLER.md
CLAUDE_CLI_CURL_INSTALLER.md
 
 
CLAUDE_CLI_CURL_INSTALLER_QUICK_REF.md
CLAUDE_CLI_CURL_INSTALLER_QUICK_REF.md
 
 
CLAUDE_CONVERSATIONS_API.md
CLAUDE_CONVERSATIONS_API.md
 
 
CLAUDE_OAUTH_ACCESS_TOKEN_APPROACH.md
CLAUDE_OAUTH_ACCESS_TOKEN_APPROACH.md
 
 
CLAUDE_OAUTH_FIX.md
CLAUDE_OAUTH_FIX.md
 
 
CLAUDE_OAUTH_IMPLEMENTATION_SUMMARY.md
CLAUDE_OAUTH_IMPLEMENTATION_SUMMARY.md
 
 
CLAUDE_OAUTH_ON_DEMAND_CLI.md
CLAUDE_OAUTH_ON_DEMAND_CLI.md
 
 
CLAUDE_OAUTH_READY.md
CLAUDE_OAUTH_READY.md
 
 
CLAUDE_OAUTH_STATUS_2026.md
CLAUDE_OAUTH_STATUS_2026.md
 
 
CLAUDE_OAUTH_TOKEN_AUTH_FIX.md
CLAUDE_OAUTH_TOKEN_AUTH_FIX.md
 
 
CLAUDE_TOOL_RESULT_FORMAT_FIX.md
CLAUDE_TOOL_RESULT_FORMAT_FIX.md
 
 
CLOUD_AGENT_GATEWAY_PLAN.md
CLOUD_AGENT_GATEWAY_PLAN.md
 
 
CLOUD_SYNC_READY_PIPELINE.md
CLOUD_SYNC_READY_PIPELINE.md
 
 
CODE_BASED_DATABASE_DISCOVERY.md
CODE_BASED_DATABASE_DISCOVERY.md
 
 
CODE_INDEXING.md
CODE_INDEXING.md
 
 
CODE_INDEXING_503_FIX.md
CODE_INDEXING_503_FIX.md
 
 
CODE_INDEXING_TRACKING_IMPLEMENTATION.md
CODE_INDEXING_TRACKING_IMPLEMENTATION.md
 
 
CODE_MEMORY_UI_IMPLEMENTATION.md
CODE_MEMORY_UI_IMPLEMENTATION.md
 
 
COLLAPSIBLE_CARDS_WITH_TIMER.md
COLLAPSIBLE_CARDS_WITH_TIMER.md
 
 
COMPLETE_CONTEXT_FIX.md
COMPLETE_CONTEXT_FIX.md
 
 
COMPLETE_TEST_COVERAGE.md
COMPLETE_TEST_COVERAGE.md
 
 
CONTEXT_DROPDOWN_IMPROVEMENTS.md
CONTEXT_DROPDOWN_IMPROVEMENTS.md
 
 
CONTEXT_INSPECTOR_DISPLAY_IMPROVEMENTS.md
CONTEXT_INSPECTOR_DISPLAY_IMPROVEMENTS.md
 
 
CONTEXT_INSPECTOR_FEATURE.md
CONTEXT_INSPECTOR_FEATURE.md
 
 
CONTEXT_INSPECTOR_FIXES.md
CONTEXT_INSPECTOR_FIXES.md
 
 
CONTEXT_LENGTH_FIX_SUMMARY.md
CONTEXT_LENGTH_FIX_SUMMARY.md
 
 
CONTEXT_MANAGEMENT_BEST_PRACTICES.md
CONTEXT_MANAGEMENT_BEST_PRACTICES.md
 
 
CONTEXT_MENU_FIX.md
CONTEXT_MENU_FIX.md
 
 
CONTEXT_PRESSURE_RETRY_FIX.md
CONTEXT_PRESSURE_RETRY_FIX.md
 
 
COST_TRACKING_COMPLETE.md
COST_TRACKING_COMPLETE.md
 
 
CROSS_DEVICE_SYNC_EXPLAINED.md
CROSS_DEVICE_SYNC_EXPLAINED.md
 
 
CROSS_PLATFORM_CALENDAR_STRATEGY.md
CROSS_PLATFORM_CALENDAR_STRATEGY.md
 
 
CROSS_PLATFORM_JOB_ANALYSIS.md
CROSS_PLATFORM_JOB_ANALYSIS.md
 
 
CURSOR_DELEGATION_API.md
CURSOR_DELEGATION_API.md
 
 
CUSTOM_KEYS.md
CUSTOM_KEYS.md
 
 

README.md

Paprwork V2 Documentation

Comprehensive documentation for Paprwork V2 - AI-powered desktop assistant.

📁 Documentation Structure

/architecture

System architecture, design decisions, and technical specifications.

Files:

  • SYSTEM_OVERVIEW.md - High-level system architecture
  • CORE_LIBRARY.md - Shared core library design
  • GATEWAY_ARCHITECTURE.md - Gateway process architecture
  • IPC_PROTOCOL.md - Inter-process communication design
  • DATA_FLOW.md - How data flows through the system

/guides

User and developer guides for getting started and working with the system.

Files:

  • GETTING_STARTED.md - Quick start guide
  • DEVELOPMENT_SETUP.md - Dev environment setup
  • BUILDING_TOOLS.md - How to create custom tools
  • TESTING_GUIDE.md - How to write and run tests
  • DEPLOYMENT.md - How to build and distribute

/api

API references and specifications.

Files:

  • CORE_API.md - Core library API reference
  • IPC_API.md - IPC methods and channels
  • TOOL_API.md - Tool creation API
  • STREAMING_API.md - Streaming protocol

/implementations

Implementation details for completed features.

Files:

  • Will be added as features are implemented
  • One file per major feature
  • Includes rationale, approach, and lessons learned

/improvements

Ideas for future improvements and enhancements.

Files:

  • Will be added as we identify improvement opportunities
  • Tracks potential optimizations and new features

🔍 Quick Navigation

For New Developers

  1. Read GETTING_STARTED.md
  2. Review SYSTEM_OVERVIEW.md
  3. Check DEVELOPMENT_SETUP.md
  4. See CLAUDE.md for project context

For Tool Development

  1. Read BUILDING_TOOLS.md
  2. Check TOOL_API.md
  3. See example tools in src/core/tools/

For Architecture Understanding

  1. Start with SYSTEM_OVERVIEW.md
  2. Read CORE_LIBRARY.md
  3. Understand GATEWAY_ARCHITECTURE.md
  4. Review DATA_FLOW.md

📝 Documentation Standards

Writing Guidelines

  • Use clear, concise language
  • Include code examples where relevant
  • Keep files focused on one topic
  • Update docs when code changes

File Naming

  • Use UPPERCASE for major docs (README.md, CLAUDE.md)
  • Use UPPERCASE_WITH_UNDERSCORES for doc files
  • Use clear, descriptive names

Markdown Formatting

  • Use proper heading hierarchy (# → ## → ###)
  • Include table of contents for long docs
  • Use code fences with language tags
  • Add images/diagrams where helpful

🔄 Keeping Docs Updated

When to update documentation:

  • Adding new features → Update relevant API docs
  • Changing architecture → Update architecture docs
  • Fixing bugs → Update troubleshooting guides
  • Making decisions → Update CLAUDE.md

Who updates docs:

  • Developers update API/implementation docs
  • Architects update architecture docs
  • Project leads update CLAUDE.md and plans

📚 Related Documentation

Root Level

Plans

  • /plans - Detailed feature plans and specifications

Code

🎯 Documentation TODOs

  • Write SYSTEM_OVERVIEW.md
  • Write CORE_LIBRARY.md
  • Write GATEWAY_ARCHITECTURE.md
  • Write GETTING_STARTED.md
  • Write DEVELOPMENT_SETUP.md
  • Write BUILDING_TOOLS.md
  • Write IPC_API.md

Last Updated: 2026-02-09