Skip to content

Add homepage link to VS Code README and create LLM prompt page for Chartifact creation - #76

Merged
Dan Marshall (danmarshall) merged 15 commits into
mainfrom
copilot/fix-c4263eed-656b-4c4f-9924-253d356164df
Sep 10, 2025
Merged

Add homepage link to VS Code README and create LLM prompt page for Chartifact creation#76
Dan Marshall (danmarshall) merged 15 commits into
mainfrom
copilot/fix-c4263eed-656b-4c4f-9924-253d356164df

Conversation

Copilot AI commented Sep 9, 2025

Copy link
Copy Markdown
Contributor

This PR addresses the need for better discoverability and AI-assisted creation workflows by:

  • Adding homepage link to VS Code extension README - Users can now easily navigate from the VS Code extension to the main Chartifact website for additional resources and examples.

  • Creating a comprehensive LLM prompt page - New /docs/prompt.html page that provides users with everything they need to create Chartifact documents using their preferred LLM:

    • Step-by-step workflow instructions
    • Complete, copyable prompt optimized for Chartifact document generation
    • Guidance on selecting relevant examples from the gallery
    • Instructions for using the online viewer to preview, edit, and export documents
    • Remixing and Format Conversion section explaining how to convert between document types (reports to slideshows, etc.)
    • Enhanced workflow guidance with online viewer link embedded directly in the prompt
    • Format selection guidance and JSON format recommendation for chat interfaces that render markdown
  • Address feedback:

    • Fixed Jekyll links to use /prompt instead of /prompt.html
    • Reverted docs/index.html since it's generated from root README - moved link to root README.md instead
    • Removed all emojis from prompt page section headers and VS Code README
    • Changed "Create with AI" to "Try now with your LLM" throughout
    • Reverted generated docs/examples.html and moved changes to source file in packages/web-deploy/src/example-folders.mts
    • Updated prompt instructions from "paste here" to "add the example files to the chat"
    • Enhanced "Calculators" to "Calculators & What-if Analysis"
    • Added guidance about choosing one format and sticking with it to avoid mixing formats
  • Latest improvements:

    • Removed example file instructions from prompt text - moved to outer workflow instructions
    • Changed prompt to say "See attached" instead of requiring users to modify the prompt
    • Added clipboard copy functionality with visual feedback
    • Moved chat interface rendering note from prompt to tips section
    • Added format selection guidance prominently at the beginning
    • Removed "convert between json and markdown" from conversion section
    • Added "Research Summaries" use case highlighting Deep Research workflow integration

The new prompt page includes Chartifact-specific requirements like:

  • Proper file format specifications (.idoc.md or .idoc.json)
  • Component usage guidelines (charts, tables, inputs, etc.)
  • Security constraints (no HTML elements allowed)
  • Styling best practices

Key workflow improvements:

  • Users no longer need to modify the prompt - just attach examples and copy the standard prompt
  • Clear format selection guidance prevents mixing formats
  • Copy button with visual feedback makes it easy to get the prompt text
  • Enhanced tips section covers chat interface quirks

Navigation improvements:

  • Homepage now includes "Try now with your LLM" link in the main navigation
  • Examples page includes call-to-action linking to the new prompt page
  • VS Code README prominently displays homepage link at the top (without emoji)

Implementation details:

  • Jekyll-compatible links using /prompt instead of /prompt.html
  • Clean design without emojis, consistent with other project pages
  • Changes made to source files instead of generated files
  • JavaScript clipboard functionality with proper error handling

This creates a seamless workflow: users discover Chartifact → browse examples → use AI to create their own documents → refine in the online viewer → export and share.

Updated prompt page with copy button and improved workflow

The prompt page will be available at: https://microsoft.github.io/chartifact/prompt


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

…I creation instructions

Co-authored-by: danmarshall <11507384+danmarshall@users.noreply.github.com>
Copilot AI changed the title [WIP] Vscode readme page needs a link to the homepage. Also create a new page on the website: prompt.html which tellse the user how to create their own chartifact with their llm. This page will have a code block containing a prompt that they can copy. The p... Add homepage link to VS Code README and create AI prompt page for Chartifact creation Sep 9, 2025
@danmarshall

Copy link
Copy Markdown
Collaborator

Copilot jekyll will strip the .html extension, so the link format is just /prompt
revert docs/index.html since that is generated by the root readme - if you do have changes, make them there.
remove emojis, we arent using them on other pages.
instead of 'Create with AI' lets say Try now with your LLM

…hange text to 'Try now with your LLM'

Co-authored-by: danmarshall <11507384+danmarshall@users.noreply.github.com>

Copilot AI commented Sep 10, 2025

Copy link
Copy Markdown
Contributor Author

Copilot jekyll will strip the .html extension, so the link format is just /prompt
revert docs/index.html since that is generated by the root readme - if you do have changes, make them there.
remove...

All feedback addressed in commit 1823f3a:

✅ Fixed Jekyll links to use /prompt instead of /prompt.html
✅ Reverted docs/index.html since it's generated from root README - moved the link to root README.md instead
✅ Removed all emojis from prompt page section headers
✅ Changed "Create with AI" to "Try now with your LLM" throughout

The prompt page is now properly configured for Jekyll and follows the project's conventions.

Copilot AI changed the title Add homepage link to VS Code README and create AI prompt page for Chartifact creation Add homepage link to VS Code README and create LLM prompt page for Chartifact creation Sep 10, 2025
@danmarshall

Copy link
Copy Markdown
Collaborator

Copilot - docs/examples is generated, undo it here and make changes in web-deploy
remove emoji from vscode readme

…ADME emoji

Co-authored-by: danmarshall <11507384+danmarshall@users.noreply.github.com>

Copilot AI commented Sep 10, 2025

Copy link
Copy Markdown
Contributor Author

Copilot - docs/examples is generated, undo it here and make changes in web-deploy
remove emoji from vscode readme

Changes addressed in commit 40d6e82:

✅ Reverted docs/examples.html since it's generated - moved the call-to-action text to the source file packages/web-deploy/src/example-folders.mts instead
✅ Removed emoji from VS Code README

The examples page call-to-action is now properly implemented in the web-deploy source file that generates the final HTML.

@danmarshall

Copy link
Copy Markdown
Collaborator

Copilot I think instead of "paste here" lets just say to add the example files to the chat. lets also have in the prompt the link to the online viewer, to make the workflow easy they wont be coming back to this page to get it.
Lets also add a new section about remixing, that a user can convert a report to a slideshow or other formats.

for Calculators lets also use the phrase What-if Analysis.

Remind users they need to choose a format and stick with it - no format mixing. One thing to note is that chat streams sometimes render the markdown instead of allowing users to copy source code. in this case encourage the json format

…and add remixing section

Co-authored-by: danmarshall <11507384+danmarshall@users.noreply.github.com>

Copilot AI commented Sep 10, 2025

Copy link
Copy Markdown
Contributor Author

Copilot I think instead of "paste here" lets just say to add the example files to the chat. lets also have in the prompt the link to the online viewer, to make the workflow easy they wont be coming b...

All feedback addressed in commit d4cbe1b:

✅ Changed "paste here" to "add the example files to the chat" for clearer instructions
✅ Added online viewer link directly in the copyable prompt for seamless workflow
✅ Added new "Remixing and Format Conversion" section explaining document type conversions
✅ Updated "Calculators" to "Calculators & What-if Analysis"
✅ Added guidance about choosing one format and sticking with it
✅ Added note about JSON format being better when chat interfaces render markdown

The prompt now includes the complete workflow guidance users need without having to return to the page.

@danmarshall

Copy link
Copy Markdown
Collaborator

Remove this section from the prompt: Here are some example Chartifact documents for reference:
Add your chosen example files to the chat

Instead this should be in the outer instructions and in the prompt it should say See attached. Basically the user should not have to surgically modify the prompt.

can you also add somce clipboard code for the prompt.

in conversion remove "convert between h=json and markdown" - this is not possible.

Also lets say that a great way to use this is at the end of Deep Research, where they have some findings and now want a report
Perhaps under "what you can create" ?

@danmarshall

Copy link
Copy Markdown
Collaborator

Copilot why is "Note: If your chat interface renders markdown instead of showing the source code, request the JSON format (.idoc.json) instead as it's easier to copy." inside of the prompt?? it is an instruction to the user. I think at the beginning we need to make sure they choose one format and stick with it.
move the chat thing to tips

…lipboard functionality

Co-authored-by: danmarshall <11507384+danmarshall@users.noreply.github.com>

Copilot AI commented Sep 10, 2025

Copy link
Copy Markdown
Contributor Author

Remove this section from the prompt: Here are some example Chartifact documents for reference:
Add your chosen example files to the chat

...

All feedback addressed in commit f9fc63a:

✅ Removed "Here are some example Chartifact documents for reference" section from prompt - moved to outer instructions in step 2
✅ Changed prompt to say "See attached example Chartifact documents for reference"
✅ Added clipboard copy button with visual feedback ("Copied!" confirmation)
✅ Removed "convert between json and markdown" from conversion section
✅ Added "Research Summaries" use case highlighting Deep Research workflow integration

Users can now copy the standard prompt without modification and just attach their chosen example files.

Copilot why is "Note: If your chat interface renders markdown instead of showing the source code, request the JSON format (.idoc.json) instead as it's easier to copy." inside of the prompt?? it is an...

Fixed in commit f9fc63a:

✅ Moved the note about chat interface rendering markdown out of the prompt and into the tips section under "Format selection"
✅ Added prominent format selection guidance at the beginning in the "Important" section right after the workflow steps
✅ Users no longer need to modify the prompt - the chat interface note is now properly in the tips section where it belongs

The prompt is now clean and users get the format guidance upfront before they start.

@danmarshall
Dan Marshall (danmarshall) merged commit cbce9a0 into main Sep 10, 2025
4 checks passed
@danmarshall
Dan Marshall (danmarshall) deleted the copilot/fix-c4263eed-656b-4c4f-9924-253d356164df branch September 10, 2025 19:40
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