Generating SR Widget Documentation Using Github Copilot

This tutorial is for SR widget owners, who are generating documentation for their widgets in compliance with BETS documentation guidelines.

The goal of this tutorial is to demonstrate a procedure that results in a generated document, which fulfills or is very close to fulfilling BETS documentation guidelines.

#Prerequisites

• VS Code with Github Copilot plugins installed and configured
  • Github Copilot account
• Access to widgets source code
• Access to widgets demo page
• Access to API hub MarkDown guide

#Steps

1. Open the main source file of your widget (could be index.jsx or props.ts, you know which one it is)
2. Go to the API hub MarkDown guide

• On the upper right click the Copy page button

3. Open Github Copilot chat

• Build context
  • Open the generate_widget_integration_doc.txt file
  • Render and paste prompts 1 through 5 into the chat
    • make sure you replace the placeholders with files
  • Allow website access requests that might come up
• Generate document
  • Paste prompt 6 into the chat

4. Wait, it takes a few minutes to generate the document
5. Examine the document

• Get Copilot to correct the document with follow up prompts.