Skip to content

Replace the experimental badge with a shorter unstable one - #600

Merged
rymsha merged 1 commit into
masterfrom
claude/xp-docs-coverage-audit-82fv2f
Aug 25, 2026
Merged

Replace the experimental badge with a shorter unstable one#600
rymsha merged 1 commit into
masterfrom
claude/xp-docs-coverage-audit-82fv2f

Conversation

@rymsha

@rymsha rymsha commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

experimental.svg rendered 91px wide — half again as wide as the badges it sits beside — so it broke the line wherever it appeared inline.

Badge Width
experimental.svg (removed) 91px
unstable.svg (new) 66px
preview.svg 63px
xp-8010.svg 64px

Same generator, same shields.io geometry and Verdana metrics, same #fe7d37 orange — only the label is shorter. "unstable" says the same thing about an API: not settled, may change or be withdrawn.

Three call sites: threadPool.virtualThreads and threadPool.virtualThreads.maxConcurrent in config/system.adoc, and the virtual-threads entry in the 8.1 release notes. The prose is untouched — it already says "treat it as an experiment" and "not for production", which reads correctly under either badge.

Paired with enonic/doc-code#81, which does the same swap there.


Generated by Claude Code

At 91px the experimental badge was half again as wide as the badges it
sits beside - preview is 63, the version badge 64 - so it broke the line
wherever it appeared. "unstable" renders at 66px, and says the same
thing about an API: not settled, may change or be withdrawn.

The sentences next to the badge in doc-code drop "experimental" for the
same reason of consistency; the virtual-thread text already said "treat
it as an experiment" and "not for production", which needs no change.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HojPYKFnpQsNmRoMu3GD9c
@rymsha
rymsha requested review from anatol-sialitski and a lite review from Copilot August 25, 2026 11:02

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR updates Enonic XP documentation to replace the wider experimental.svg inline badge with a shorter unstable.svg badge, avoiding unwanted line breaks where the badge is used inline.

Changes:

  • Updated the virtual threads badge in the XP 8.1 release notes to use unstable.svg.
  • Updated threadPool.virtualThreads and threadPool.virtualThreads.maxConcurrent config reference entries to use unstable.svg.
  • Adjusted the docs/images/unstable.svg asset to render the “unstable” label at the intended smaller width.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File Description
docs/release.adoc Swaps the virtual-threads badge from experimental.svg to unstable.svg in the release notes.
docs/images/unstable.svg Updates the SVG geometry/text to render the shorter “unstable” badge (66px wide).
docs/config/system.adoc Replaces the experimental.svg badge with unstable.svg for the two virtual-threads config keys.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@rymsha
rymsha merged commit 4253b51 into master Aug 25, 2026
1 check passed
@rymsha
rymsha deleted the claude/xp-docs-coverage-audit-82fv2f branch August 25, 2026 11:04
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.

3 participants