Skip to content

Add examples page with direct links to interactive demos and enhance folder metadata#58

Closed
danmarshall with Copilot wants to merge 4 commits into
mainfrom
copilot/fix-2c6c6780-bb08-4ab7-b8f9-257e21396560
Closed

Add examples page with direct links to interactive demos and enhance folder metadata#58
danmarshall with Copilot wants to merge 4 commits into
mainfrom
copilot/fix-2c6c6780-bb08-4ab7-b8f9-257e21396560

Conversation

Copilot AI commented Aug 26, 2025

Copy link
Copy Markdown
Contributor

This PR adds a new docs/examples.md page that provides direct links to interactive Chartifact demos and enhances the original examples folder metadata with descriptions.

What's Added

  • New Examples Page: docs/examples.md with Jekyll front matter for proper site integration
  • Direct Demo Links: Each example links directly to the Chartifact viewer using the load parameter
  • Enhanced Folder Metadata: Added description properties to docs/assets/examples/examples.markdown.folder.json
  • Five Interactive Examples:
    • Why Chartifact - Discover the capabilities and benefits of Chartifact for creating interactive data documents
    • Sales Dashboard - A comprehensive sales dashboard with interactive charts and data visualization
    • Sales Report - A detailed sales report with tabular data and analysis
    • Grocery List - An interactive grocery list demonstrating form controls and data management
    • Mermaid Org Chart - An organizational chart created using Mermaid diagrams with dynamic data

URL Format

All links follow the pattern:

https://microsoft.github.io/chartifact/view/?load=https://raw.githubusercontent.com/microsoft/chartifact/[commit]/packages/web-deploy/json/[filename].idoc.json

This allows users to directly access any example without navigating through the folder interface, making it easier to share specific demos or bookmark favorites.

The page will be accessible at https://microsoft.github.io/chartifact/examples once deployed. The enhanced folder metadata also provides better descriptions for the examples when viewed through the folder interface.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: danmarshall <11507384+danmarshall@users.noreply.github.com>
Copilot AI changed the title [WIP] based on this file docs/assets/examples/examples.markdown.folder.json , can you mae a new page docs/examples.md that is a list of these same demos. you can link to each one via the 'load' param like https://microsoft.github.io/chartifact/view/?load=h... Add examples page with direct links to interactive demos Aug 26, 2025
Copilot AI requested a review from danmarshall August 26, 2025 02:39
@danmarshall

Copy link
Copy Markdown
Collaborator

@copilot can you merge main. after that, please populate the description property in the original file.

Copilot AI and others added 2 commits August 26, 2025 04:36
…6560

# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
Co-authored-by: danmarshall <11507384+danmarshall@users.noreply.github.com>

Copilot AI commented Aug 26, 2025

Copy link
Copy Markdown
Contributor Author

@copilot can you merge main. after that, please populate the description property in the original file.

I've successfully merged main and populated the description property in the original file (docs/assets/examples/examples.markdown.folder.json). The descriptions match the content from the examples.md page I created. Changes committed in c3d99d0.

Copilot AI changed the title Add examples page with direct links to interactive demos Add examples page with direct links to interactive demos and enhance folder metadata Aug 26, 2025
@danmarshall
danmarshall deleted the copilot/fix-2c6c6780-bb08-4ab7-b8f9-257e21396560 branch September 4, 2025 04:59
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.

2 participants