Skip to content

Release prep and docs - #6

Merged
goldenapples merged 15 commits into
mainfrom
release-prep-and-docs
Sep 7, 2026
Merged

Release prep and docs#6
goldenapples merged 15 commits into
mainfrom
release-prep-and-docs

Conversation

@goldenapples

@goldenapples goldenapples commented Sep 6, 2026

Copy link
Copy Markdown
Collaborator

Chores required to prep this for public release:

  • Adds CI workflows, lint, and test suites
  • Updates README and adds a CONTRIBUTING.md
  • Adds a docs site with user documentation

The docs site is deployed to https://humanmade.github.io/wp-pattern-library/, for easier reading.

@kadamwhite kadamwhite left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good overall but a few things worth fixing, and we may need to iterate on the action dispatch system.

Comment thread .github/workflows/tag-and-release.yml Outdated
Comment thread docs/01-index.md Outdated
Comment thread .github/workflows/deploy-docs.yml Outdated
Comment thread docs/04-npm-package.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread docs/05-github-action.md Outdated
Comment thread composer.json
<link rel="apple-touch-icon" sizes="180x180" href="{{ site.baseurl }}/assets/favicon/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="{{ site.baseurl }}/assets/favicon/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="{{ site.baseurl }}/assets/favicon/favicon-16x16.png">
<link rel="manifest" href="{{ site.baseurl }}/assets/favicon/site.webmanifest">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Favicon isn't present in repo

@goldenapples goldenapples Sep 7, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Ture, but it seems to be building correctly in the published site. I think it's pulled in from https://github.com/humanmade/just-the-hm-docs/tree/main/assets/favicon.

Comment thread README.md Outdated
be the same host, and the site does not need Node.

## Contributing and releases
WordPress 6.0+ · PHP 8.1+ · Node 24+

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Claude sussed out that we're actually WP 6.1+, since we depend on wp_style_engine_get_styles.

Suggested change
WordPress 6.0+ · PHP 8.1+ · Node 24+
WordPress 6.1+ · PHP 8.1+ · Node 24+

Comment thread docs/_config.yml
description: Generate a Markdown pattern library, with screenshots, from a WordPress site's registered block patterns — from your local environment or from production.
author: Human Made
baseurl: '/wp-pattern-library'
url: 'https://humanmade.github.io'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Claude noted that we should probably exclude: the docs/architecture/*.md ADR folder in this file, or else add markdown frontmatter to those files so they're viewable properly on the site.

@goldenapples
goldenapples merged commit 68229df into main Sep 7, 2026
5 checks passed
@goldenapples
goldenapples deleted the release-prep-and-docs branch September 7, 2026 19:30
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