Skip to content

Add index page and include all example scripts in README and workflows#20

Merged
daedeloth merged 2 commits intomasterfrom
copilot/update-readme-examples
Feb 10, 2026
Merged

Add index page and include all example scripts in README and workflows#20
daedeloth merged 2 commits intomasterfrom
copilot/update-readme-examples

Conversation

Copy link
Contributor

Copilot AI commented Feb 10, 2026

README and PR preview workflow only listed 4 of 7 examples, and the GitHub Pages root had no index page.

Changes

  • app/index.html — New landing page for GitHub Pages with feature overview, all 7 example links, quick start, and API reference
  • Gruntfile.js — Copy app/index.html to dist/ during build
  • README.md — Add missing examples (Background & Fill, BigText, Emoji Text), link to docs page, expand features list
  • .github/workflows/deploy-pr.yml — Add missing examples to PR preview comment
  • .gitignore — Exclude dist/index.html build artifact

Index page preview

Index page

Original prompt

This section details on the original issue you should resolve

<issue_title>Update readme</issue_title>
<issue_description>Readme (and workflow items) don't include all example scripts and https://catlabinteractive.github.io/easelbone/ doesn't contain an index file. Make sure that all example scripts are included and there is an overview / documentation page at https://catlabinteractive.github.io/easelbone/

The index page should contain a few examples already and give a nice overview on what is included in this library.

Also, analyse the code and see if there are any other intersting examples that can be included.</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

- Create app/index.html with overview, features, all 7 example links,
  installation, quick start code, and API overview
- Update Gruntfile.js to copy index.html to dist/
- Update README.md with missing examples and documentation link
- Update deploy-pr.yml PR comment with all example links
- Add dist/index.html to .gitignore

Co-authored-by: daedeloth <1168599+daedeloth@users.noreply.github.com>
Copilot AI changed the title [WIP] Update readme with example scripts and index page Add index page and include all example scripts in README and workflows Feb 10, 2026
@github-actions
Copy link

📦 PR Preview deployed!

Examples are available at:

Copilot AI requested a review from daedeloth February 10, 2026 09:30
@daedeloth daedeloth marked this pull request as ready for review February 10, 2026 09:38
@daedeloth daedeloth merged commit 91af557 into master Feb 10, 2026
1 check passed
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.

Update readme

2 participants