Skip to content

docs(readme): remove the docs-site CI status badge#97

Merged
danielPoloWork merged 1 commit into
masterfrom
docs/remove-docs-site-badge
Jun 15, 2026
Merged

docs(readme): remove the docs-site CI status badge#97
danielPoloWork merged 1 commit into
masterfrom
docs/remove-docs-site-badge

Conversation

@danielPoloWork

Copy link
Copy Markdown
Owner

Summary

Removes the redundant docs-site CI status badge from the README header in all three locales (English, zh-Hans, ja). Documentation-only — no API/behaviour change. The docs-site.yml workflow is unchanged.

Motivation

The published Doxygen site is already linked from the README's API reference badge, so the separate docs-site build-status badge was redundant clutter in the header. Maintainer request.

Changes

  • README.md, docs/i18n/zh-Hans/README.md, docs/i18n/ja/README.md — drop the docs-site badge line.
  • docs/i18n/translation-status.md — the two README rows are marked stale (the English source moved ahead of their pin; the repo squash-merges so a pin to this branch's commit would be orphaned). A follow-up re-pins them to this change's master commit and flips them back to translated.
  • CHANGELOG.mdUnreleased Removed entry.

Design Patterns

  • None — documentation.

Verification

  • python tools/consistency_lint.py — OK (i18n-freshness skips the stale README rows, so green)
  • markdownlint-cli2 clean on the five changed files
  • docs-site badge confirmed absent from all three READMEs

Documentation Impact

  • README (all locales) + CHANGELOG updated
  • No code / spec / ADR change
  • PR metadata set — assignee, documentation label, v1.1.2 milestone (§6.4 / ADR-0040)

Follow-up

A tiny manifest-only PR after this merges: flip the two README rows back to translated and re-pin them to this change's master commit (the established post-source-change i18n step).

🤖 Generated with Claude Code

The published Doxygen site is already reachable from the README's
**API reference** badge, so the separate `docs-site` build-status badge
in the header was redundant. Remove it from all three locales (English,
zh-Hans, ja). The docs-site.yml workflow itself is unchanged.

Because this moves the English README ahead of the translation pins and
the repo squash-merges (which would orphan a pin to this branch's
commit), the two README rows in translation-status.md are marked `stale`
here; a follow-up re-pins them to this change's master commit and flips
them back to `translated`. The i18n-freshness lint skips `stale` rows,
so the gate stays green. Documentation-only; no API/behaviour change.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@danielPoloWork danielPoloWork added this to the v1.1.2 milestone Jun 15, 2026
@danielPoloWork danielPoloWork added the documentation Improvements or additions to documentation label Jun 15, 2026
@danielPoloWork danielPoloWork self-assigned this Jun 15, 2026
@danielPoloWork danielPoloWork merged commit 6f1aa60 into master Jun 15, 2026
4 checks passed
danielPoloWork added a commit that referenced this pull request Jun 15, 2026
…val (#98)

## Summary
Manifest-only follow-up that completes the i18n step deferred by #97:
re-pins the two README translation rows to #97's `master` commit
(`6f1aa60`) and flips them `stale` → `translated`. No content or API
change.

## Motivation
#97 removed the `docs-site` badge from the English README (and the
translations), moving the English source ahead of the translation pins.
Because the repo squash-merges, #97 could not re-pin to its own
(orphaned) branch commit, so it marked the rows `stale`. Now that the
change is on `master` as `6f1aa60`, the pins can be advanced and the
rows restored to `translated`.

## Changes
- `docs/i18n/translation-status.md` — both README rows: source commit /
translated-at → `6f1aa60`, status `stale` → `translated`.

## Design Patterns
- None — manifest bookkeeping.

## Verification
- [x] `python tools/consistency_lint.py` — OK (`i18n-freshness` green:
README unchanged since `6f1aa60`, rows now `translated`)
- [x] `markdownlint-cli2` clean

## Documentation Impact
- [x] Manifest updated; the arc was already recorded in #97's
`CHANGELOG` entry — no new CHANGELOG line needed
- [x] PR metadata set — assignee, `documentation` label, `v1.1.2`
milestone (§6.4 / ADR-0040)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant