-
Notifications
You must be signed in to change notification settings - Fork 9
Port over the Aspire dashboard bits #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request adds comprehensive documentation for the Aspire dashboard, including guides for standalone usage, configuration, security, and integration with various platforms (Node.js, Python). The changes enable a new Dashboard section in the sidebar navigation with multiple sub-pages covering dashboard features, GitHub Copilot integration, MCP server functionality, and tutorials.
- Adds 12 new documentation pages covering dashboard overview, exploration, configuration, standalone mode, Copilot, MCP server, security, and platform-specific tutorials
- Updates sidebar navigation to include the new Dashboard section with proper translations
- Adds supporting components (LoopingImage) and assets for enhanced documentation
- Includes CSS updates for better table formatting
Reviewed Changes
Copilot reviewed 16 out of 80 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/frontend/src/styles/site.css |
Adds CSS rules for table cell code blocks and vertical alignment |
src/frontend/src/content/docs/index.mdx |
Adds link to dashboard overview documentation |
src/frontend/src/content/docs/dashboard/standalone.mdx |
Documents how to run the dashboard in standalone mode |
src/frontend/src/content/docs/dashboard/standalone-for-python.mdx |
Tutorial for integrating dashboard with Python apps |
src/frontend/src/content/docs/dashboard/standalone-for-nodejs.mdx |
Tutorial for integrating dashboard with Node.js apps |
src/frontend/src/content/docs/dashboard/security-considerations.mdx |
Security best practices and configuration guidance |
src/frontend/src/content/docs/dashboard/overview.mdx |
High-level introduction to the Aspire dashboard |
src/frontend/src/content/docs/dashboard/microsoft-collected-dashboard-telemetry.mdx |
Documents telemetry collection and opt-out options |
src/frontend/src/content/docs/dashboard/mcp-server.mdx |
Explains Aspire MCP server integration |
src/frontend/src/content/docs/dashboard/explore.mdx |
Comprehensive guide to dashboard features |
src/frontend/src/content/docs/dashboard/enable-browser-telemetry.mdx |
Instructions for browser telemetry configuration |
src/frontend/src/content/docs/dashboard/copilot.mdx |
GitHub Copilot integration documentation |
src/frontend/src/content/docs/dashboard/configuration.mdx |
Dashboard configuration reference |
src/frontend/src/components/LoopingImage.astro |
Component for animated GIF images with pause controls |
src/frontend/sidebar.topics.ts |
Adds Dashboard section to sidebar with translations |
src/frontend/src/content/docs/dashboard/security-considerations.mdx
Outdated
Show resolved
Hide resolved
…figurations - Introduced new articles on enabling browser telemetry, exploring dashboard features, and using the MCP server. - Documented Microsoft-collected telemetry and how to opt-out. - Provided an overview of the Aspire dashboard and security considerations. - Added guides for using the dashboard in standalone mode with Node.js and Python applications. - Included detailed instructions for configuring OpenTelemetry and sending telemetry data to the dashboard.
…nctionality - Implemented LoopingImage component to handle GIFs with a toggle for play/pause. - Added placeholder image support based on current theme. - Included accessibility features for screen readers. - Enhanced user experience with fade-in effects and button visibility controls. - Styled component with responsive design for hover and touch devices.
…syntax in documentation
…ndalone documentation
c2b166c to
1df1e9c
Compare
… adding framework selection and improved structure
- Updated the "Explore" label to "Explore features" with improved translations. - Moved "Standalone mode" and "Configuration" topics to new positions in the sidebar. - Added detailed items under "Standalone mode" for Node.js and Python applications. - Changed "Enable browser telemetry" label and updated translations. - Removed redundant "Tutorials" section and integrated relevant items into existing topics. - Updated Docker image tags in documentation to use "latest" instead of specific version numbers. - Enhanced various documentation sections with consistent terminal tab usage for commands. - Improved CSS styles for sidebar font sizes to enhance readability.
I got you @JamesNK:
/cc @davidfowl