Skip to content

[Feat]: In-App Documentation: Embed GitHub Pages/Docusaurus Docs via Iframe #1798

@IsmaelMartinez

Description

@IsmaelMartinez

Describe the feature

Provide the current GitHub Pages documentation (from the docs folder) within the Teams for Linux application as an in-app resource. To start, display the documentation site inside an iframe available from the app menu or help section. This should work cross-platform and respect the user's theme where possible. The solution should be maintainable and allow for future enhancements (e.g., offline docs or deeper integration).

Motivation

Improves user experience by giving immediate access to high-quality documentation, troubleshooting guides, and user/developer information without leaving the app. Supports onboarding, reduces support requests, and aligns with the future-ready architecture described in the PRD. Provides a foundation for future enhancements such as offline docs or contextual help.

Alternatives

  • Continue linking users to external GitHub Pages documentation (current behavior)
  • Package the docs as static HTML within the app (requires build process and regular sync)
  • Use a webview or custom browser panel instead of an iframe
  • Ignore in-app docs and focus on external resources only

Additional context

Reference: Product Requirements Document (PRD) 'GitHub Pages Documentation Enhancements' as detailed above. The goal is to make documentation more discoverable and accessible, starting with an iframe-based solution and iterating to deeper integration (e.g., offline, search sync, or native rendering).

Metadata

Metadata

Labels

documentationMissing documentation or improving neededenhancementNew feature or request

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions