Skip to content

chore: Improve the README#10028

Merged
gonfunko merged 1 commit into
mainfrom
readme
Jun 18, 2026
Merged

chore: Improve the README#10028
gonfunko merged 1 commit into
mainfrom
readme

Conversation

@gonfunko

@gonfunko gonfunko commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

The basics

The details

Proposed Changes

This PR makes a number of changes to improve the README. Specifically, it:

  • Updates all links to our current websites
  • Adds a link to a live demo of Blockly
  • Improves the alt text on the screenshot
  • Recommends using the create-package script and provides an example
  • Adds a section about our accessibility features
  • Removes the shoutouts at the end, which I believe are obsolete at this point
  • Removes a dead link to the form to tell us about how you're using Blockly

@gonfunko gonfunko requested a review from maribethb June 17, 2026 21:29
@gonfunko gonfunko requested a review from a team as a code owner June 17, 2026 21:29
@github-actions github-actions Bot added PR: chore General chores (dependencies, typos, etc) and removed PR: chore General chores (dependencies, typos, etc) labels Jun 17, 2026

@rachel-fenichel rachel-fenichel left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

One requested follow-up: update the create-package README to start with how to use it to create an application, then move to using it to create a plugin. It's slightly confusing that we link to it for creating an application, but all information above the fold is about creating a plugin.

@gonfunko gonfunko merged commit 00fbe00 into main Jun 18, 2026
11 checks passed
@gonfunko gonfunko deleted the readme branch June 18, 2026 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: chore General chores (dependencies, typos, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants