Skip to content

Standardize CONTRIBUTING, README, and CHANGELOG docs - #445

Merged
dotNomad merged 4 commits into
mainfrom
example-docs-consistency
Aug 14, 2026
Merged

Standardize CONTRIBUTING, README, and CHANGELOG docs #445
dotNomad merged 4 commits into
mainfrom
example-docs-consistency

Conversation

@amylin1249

@amylin1249 amylin1249 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

In #433, we identified that we want to:

  • Avoid Claude - **label** style
  • Only have entries for user-facing changes in the CHANGELOG

This PR standardizes for both of those (as well as a change to the CONTRIBUTING) for: portfolio-dashboard, quarto-presentation, script-python, simple-mcp-server, simple-shiny-chat-with-mcp.

…TRIBUTING

Strip the bold labels in the Authentication section and trim the H1 to the
gallery title (these are examples, not extensions). Keeps the shared uv
template from #436.
Apply the house style to the gallery example extensions: prose over label-bullet
lists, shared setup wording, and user-facing-only changelog entries, across
portfolio-dashboard, quarto-presentation, script-python, simple-mcp-server, and
simple-shiny-chat-with-mcp.
@github-actions

github-actions Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Extension release summary

😴 Changed but won't release

The following extensions have code changes but the manifest version hasn't been incremented:

  • portfolio-dashboard: manifest version 0.0.5 ≤ released version 0.0.5
  • quarto-presentation: manifest version 1.0.2 ≤ released version 1.0.2
  • script-python: manifest version 1.0.3 ≤ released version 1.0.3
  • simple-mcp-server: manifest version 0.0.8 ≤ released version 0.0.8
  • simple-shiny-chat-with-mcp: manifest version 0.0.8 ≤ released version 0.0.8

If you intended to release these changes, update the version field in each extension's manifest.json.

See the contributing guide for details.

@amylin1249
amylin1249 marked this pull request as ready for review July 28, 2026 20:29
@amylin1249
amylin1249 requested a review from dotNomad July 28, 2026 20:29
The standardization pass replaced three older entries with "Maintenance
release; no user-facing changes." Restore what each release actually
changed instead.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

@dotNomad dotNomad 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.

@dotNomad
dotNomad merged commit d231558 into main Aug 14, 2026
53 checks passed
@dotNomad
dotNomad deleted the example-docs-consistency branch August 14, 2026 23:40
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