Skip to content

[EPIC][UI]: Integrated help center #2302

@crivetimihai

Description

@crivetimihai

Overview

Build an integrated help center within the Admin UI providing searchable documentation, FAQs, and troubleshooting guides without leaving the application.

User Stories

Help Center Access

  • As a user, I want a "Help" button/icon always accessible in the UI
  • As a user, I want help center to open in a slide-out panel (not new tab)
  • As a user, I want to search across all help content

Documentation Integration

  • As a user, I want to browse documentation organized by topic
  • As a user, I want documentation synced from docs site
  • As a user, I want version-specific documentation

FAQs & Troubleshooting

  • As a user, I want common FAQs readily available
  • As a user, I want troubleshooting decision trees
  • As a user, I want error code explanations

Search

  • As a user, I want full-text search across help content
  • As a user, I want search suggestions as I type
  • As a user, I want recent searches remembered

Feedback Loop

  • As a user, I want to rate help articles (helpful/not helpful)
  • As a user, I want to suggest improvements to articles
  • As an admin, I want to see which articles are most/least helpful

Technical Approach

  • Index docs at build time or sync from docs site
  • Use client-side search (Fuse.js, Lunr.js) or server-side
  • Slide-out panel using Alpine.js

Configuration

MCPGATEWAY_HELP_CENTER_ENABLED=true
MCPGATEWAY_HELP_DOCS_URL=https://ibm.github.io/mcp-context-forge
MCPGATEWAY_HELP_SEARCH_ENABLED=true

Acceptance Criteria

  • Help center accessible from any page
  • Documentation browsable and searchable
  • FAQs and troubleshooting guides available
  • Search returns relevant results
  • Article feedback collected

Milestone

Release 1.3.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    COULDP3: Nice-to-have features with minimal impact if left out; included if time permitsdocumentationImprovements or additions to documentationenhancementNew feature or requestepicLarge feature spanning multiple issuesfrontendFrontend development (HTML, CSS, JavaScript)uiUser Interface
    No fields configured for Feature.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions