Skip to content

Comments

docs: update README — Enterprise category, correct counts, badges, contributing guide#56

Merged
brunoborges merged 3 commits intomainfrom
copilot/update-readme-documentation
Feb 20, 2026
Merged

docs: update README — Enterprise category, correct counts, badges, contributing guide#56
brunoborges merged 3 commits intomainfrom
copilot/update-readme-documentation

Conversation

Copy link
Contributor

Copilot AI commented Feb 19, 2026

README was missing the Enterprise category entirely, had stale snippet/category counts, no badges, and a contributing workflow that referenced manual edits to a generated file.

Changes

Content corrections

  • Added Enterprise row to categories table (EJB → CDI, JDBC → JPA/Jakarta Data, JNDI → injection, MDB → reactive, REST)
  • Updated snippet count 85 → 107, category count 10 → 11

Badges

  • Added shields.io badges: GitHub Pages live, snippet count, MIT license, contributions welcome
  • Added inline note reminding maintainers to bump the snippet count badge when adding patterns

Build command

  • Kept jbang html-generators/generate.java as the primary generate command (the JAR is not committed to the repo)

Contributing workflow

  • Removed stale step: "Update site/index.html with a new preview card" (generated file, never edit directly)
  • Added step to copy content/template.json as a starting point
  • Added step to update prev/next in adjacent JSON files for navigation continuity

New file: content/template.json

  • Starter template with all required fields pre-populated with placeholder values, lowering the barrier for contributors to add new patterns correctly
Original prompt

This section details on the original issue you should resolve

<issue_title>README is outdated</issue_title>
<issue_description>It doesn't include the Enterprise category.
Counts are outdated.
No badges.
No ask for contributions (should mention the template for new slugs).
And possibly more things I am missing right now.</issue_description>

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


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

… and improved contributing guide

Co-authored-by: brunoborges <[email protected]>
Copilot AI changed the title [WIP] Update README to include enterprise category and contributions docs: update README — Enterprise category, correct counts, badges, contributing guide Feb 19, 2026
Copilot AI requested a review from brunoborges February 19, 2026 23:45

```bash
# Generate all HTML pages and data/snippets.json into site/
jbang html-generators/generate.java
Copy link
Contributor

Choose a reason for hiding this comment

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

Revert this change @copilot . Keep the jbang command only. Remember: the jar is not uploaded to the repo!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reverted in e6082cb — both the "Generate and serve" section and the Contributing step now use jbang html-generators/generate.java.

@brunoborges brunoborges marked this pull request as ready for review February 20, 2026 00:05
@brunoborges brunoborges merged commit 4147576 into main Feb 20, 2026
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.

README is outdated

2 participants