Skip to content

Add Mobile User Guide Documentation#16

Merged
jeremyeder merged 1 commit intomainfrom
docs/mobile-user-guide
Nov 27, 2025
Merged

Add Mobile User Guide Documentation#16
jeremyeder merged 1 commit intomainfrom
docs/mobile-user-guide

Conversation

@jeremyeder
Copy link
Copy Markdown
Contributor

Summary

This PR adds a comprehensive mobile user guide for end users of the ACP Mobile app. The guide covers all main screens, available settings, key features, and troubleshooting with placeholder markers for screenshots.

What was added

1. Comprehensive User Guide (docs/mobile-user-guide.md)

  • Single standalone page (easier for users to navigate)
  • Table of contents with jump links
  • 12 screenshot placeholders with consistent naming
  • Sections covering:
    • Getting Started (Installation, First Login)
    • Main Screens (Dashboard, Sessions, Notifications, Settings)
    • Key Features (Real-time monitoring, Offline mode, Theme switching)
    • Settings & Preferences (Appearance, Notifications, Repositories, Profile)
    • Tips & Troubleshooting
  • Written for both internal Red Hat users and external users with callout boxes

2. Screenshot Infrastructure

  • docs/images/screenshots/ directory created
  • docs/images/screenshots/README.md with naming conventions and requirements
  • 12 placeholder screenshots defined with consistent mobile-{feature}-{variant}.png naming

3. Documentation Integration

  • Added to "Getting Started" section in mkdocs.yml
  • Prominent link added to docs/index.md homepage
  • Successfully builds with mkdocs build

Screenshot Placeholders

The guide includes 12 placeholder screenshots with consistent naming:

  1. mobile-login-oauth.png - OAuth login screen
  2. mobile-dashboard-main.png - Main dashboard view
  3. mobile-dashboard-offline.png - Dashboard with offline banner
  4. mobile-sessions-list.png - Sessions list
  5. mobile-sessions-filters.png - Filter chips
  6. mobile-session-detail.png - Session details
  7. mobile-notifications.png - Notifications screen
  8. mobile-settings-main.png - Settings
  9. mobile-settings-appearance.png - Theme settings
  10. mobile-settings-notifications.png - Notification prefs
  11. mobile-settings-repos.png - Repo management
  12. mobile-connection-status.png - Connection indicator

Next Steps

To complete the user guide:

  1. Capture actual screenshots following specifications in docs/images/screenshots/README.md
  2. Replace placeholders following the naming convention
  3. Place in docs/images/screenshots/ directory
  4. Rebuild docs - screenshots will appear automatically!

Preview

The user guide can be viewed locally with:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements-docs.txt
mkdocs serve
# Visit http://localhost:8000/mobile-user-guide/

Files Changed

  • docs/mobile-user-guide.md - Main user guide (new)
  • docs/images/screenshots/README.md - Screenshot requirements (new)
  • docs/images/screenshots/.gitkeep - Directory marker (new)
  • mkdocs.yml - Added navigation entry
  • docs/index.md - Added prominent link

Testing

  • Documentation builds successfully with mkdocs build
  • User guide accessible at /mobile-user-guide/
  • Navigation link appears in "Getting Started" section
  • Homepage link is prominent and clear
  • All screenshot placeholders properly formatted
  • Red Hat-specific callouts render correctly

This completes the user-facing documentation portion of the mobile documentation initiative!

🤖 Generated with Claude Code

- Create standalone user guide at docs/mobile-user-guide.md
- Add 12 screenshot placeholders with consistent naming
- Create screenshot requirements in docs/images/screenshots/README.md
- Add user guide to navigation in mkdocs.yml
- Add prominent link on documentation homepage
- Cover all main screens, settings, and features
- Include Red Hat-specific callouts for internal users
- Provide step-by-step instructions for common tasks

The guide covers:
- Getting Started (installation, login)
- Main Screens (Dashboard, Sessions, Notifications, Settings)
- Key Features (real-time monitoring, offline mode, themes)
- Settings & Preferences (appearance, notifications, repos, profile)
- Tips & Troubleshooting

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@jeremyeder jeremyeder merged commit 86b5a37 into main Nov 27, 2025
@jeremyeder jeremyeder deleted the docs/mobile-user-guide branch November 27, 2025 18:03
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