Skip to content

Add UX context and development documentation system - #734

Draft
ldstreet wants to merge 1 commit into
masterfrom
agent/maple-ux-context
Draft

Add UX context and development documentation system#734
ldstreet wants to merge 1 commit into
masterfrom
agent/maple-ux-context

Conversation

@ldstreet

@ldstreet ldstreet commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Summary

NOTE: This PR contains reference documentation only. The actual UX context injection implementation is in PR #733.

This PR adds comprehensive documentation files about Maple's UX and development workflows. These serve as reference material for developers and provide the source content for the UX context that's auto-injected in PR #733.

Files

AGENTS.md (~2.9KB)

  • Quick development reference for AI assistants
  • Tech stack, directories, common commands
  • Auto-loaded by AI development tools like Claude Code

MAPLE_SYSTEM_INSTRUCTION.md (~3.3KB)

MAPLE_UX_CONTEXT.md (~14KB)

  • Comprehensive technical UI reference
  • Detailed feature descriptions with code references
  • Platform-specific differences
  • Too large for inline injection; reference only

DOCUMENTATION.md (~6KB)

  • Meta guide explaining all documentation
  • Maintenance guidelines
  • File size considerations

Relationship to PR #733

PR #733 implements the actual UX context auto-injection by:

  • Taking the key information from MAPLE_SYSTEM_INSTRUCTION.md
  • Condensing it to ~300 tokens
  • Automatically prepending it to the first message of each conversation

This PR provides the full reference documentation that:

  • Developers can read to understand Maple's UX
  • Can be updated as the UI evolves
  • Serves as the source of truth for the injected context

Status

This is a draft PR containing reference documentation. Consider:

🤖 Generated with Claude Code

Add four documentation files to provide context for both developers
and the Maple AI assistant:

**AGENTS.md** (~2KB):
- Quick development reference for AI assistants
- Tech stack, directories, common commands
- Code quality standards and git workflow
- Auto-loaded by AI development tools

**MAPLE_SYSTEM_INSTRUCTION.md** (~3KB):
- Concise system instruction for Maple assistant
- Interface detection (app vs API/proxy)
- Core UI features with usage guidance
- Designed for manual copy-paste into Settings → Preferences

**MAPLE_UX_CONTEXT.md** (~15KB):
- Comprehensive technical UI reference
- Detailed feature descriptions with code references
- Implementation details and file locations
- Platform-specific differences and availability matrix
- Reference documentation (not auto-loaded due to size)

**DOCUMENTATION.md**:
- Guide explaining purpose of each documentation file
- How files work together for different scenarios
- Maintenance guidelines and update procedures
- File size considerations and loading strategies

**Usage**:
- Developers: AI tools read AGENTS.md automatically
- Users: Copy MAPLE_SYSTEM_INSTRUCTION.md to Settings → Preferences
- Reference: Consult MAPLE_UX_CONTEXT.md for detailed UI info

**Context-aware behavior**:
- Maple assistant detects if user is in app or using API/proxy
- References UI elements (globe icon, + button) only in app context
- Uses capability language (web search available) for API context

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying maple with  Cloudflare Pages  Cloudflare Pages

Latest commit: d741814
Status: ✅  Deploy successful!
Preview URL: https://98dc6586.maple-ca8.pages.dev
Branch Preview URL: https://agent-maple-ux-context.maple-ca8.pages.dev

View logs

@ldstreet
ldstreet marked this pull request as draft August 4, 2026 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant