Skip to content

docs: hide the stale version chip in the repository header - #1139

Merged
igorpecovnik merged 1 commit into
mainfrom
docs/hide-stale-version-chip
Sep 1, 2026
Merged

docs: hide the stale version chip in the repository header#1139
igorpecovnik merged 1 commit into
mainfrom
docs/hide-stale-version-chip

Conversation

@igorpecovnik

@igorpecovnik igorpecovnik commented Sep 1, 2026

Copy link
Copy Markdown
Member

TL;DR — The repo card in the site header advertises version e76674a, a commit hash from October 2024, on a site that redeploys on every push to main. It is a leftover of the retired PDF release pipeline. Hide the version chip; keep stars and forks, which are correct.

What the card shows vs. reality

mkdocs-material fills the header repo card from the GitHub API. Two of the three facts are accurate:

Card GitHub API Verdict
★ 234 stargazers_count: 234 correct
⑂ 209 forks_count: 209 correct
🏷 e76674a releases/latest → tag_name: e76674a, published 2024-10-12 real, but 22 months stale

The card is reporting faithfully — the data behind it is the fossil.

Where e76674a came from

It was never a version. The old PDF pipeline in release.yaml published a GitHub Release per push, tagged with the short commit SHA:

      - name: Create Release
        uses: ncipollo/release-action@v1
        with:
          tag: ${{ steps.vars.outputs.sha_short }}
          name: ${{ steps.vars.outputs.timenow }}-${{ steps.vars.outputs.sha_short }}
          artifacts: armbian-document-${{ steps.vars.outputs.sha_short }}.pdf

That is why all 242 tags are 7-character hashes and the newest release is literally named 2024-10-12-e76674a. The job carrying it was commented out on 2024-11-20 in ab2258a ("Update workflows to remove PDF flow") and ca3df18 ("Disable the rest of the script as its not needed"), so releases stopped there. Today's release.yaml only builds the site and rsyncs it — it creates no tag or release at all.

The change

.md-source__fact--version {
  display: none;
}

The docs are continuously deployed and carry no version, so there is nothing meaningful to put in the chip's place.

Why CSS and not a template override: material injects these facts client-side, building the class as md-source__fact--${t} in JS. Overriding partials/source.html would mean dropping data-md-component="source", which removes stars and forks too.

Why no visual gap: .md-source__facts is a flex row using gap, each item carrying its own ::before icon — there are no textual separators — so hiding one item leaves no stray glyph or spacing.

Verification

Local mkdocs build (mkdocs-material 9.7.6): the rule ships in site/css/armbian-extra.css and the stylesheet is linked from the built pages. site/ is gitignored, so only the source CSS is committed.

Alternatives not taken

  • Resume releasing — re-enable a date-based release per deploy so the chip tracks the docs. Worth doing if the PDF artifact is wanted back.
  • Delete the stale releases/tags — the API would then return none and material would omit the chip by itself, but that destroys 30 releases and 242 tags along with any link to the archived PDFs.

Create docs preview on PR

Documentation website preview will be available shortly:


 Open WWW preview 

The repo card in the site header showed "e76674a" as the version. That is real
but meaningless: mkdocs-material fills the card from the GitHub API and renders
releases/latest as a version, and our latest release is a leftover of the
retired PDF pipeline.

That pipeline created a GitHub Release per push, tagged with the short commit
SHA (ncipollo/release-action with `tag: ${{ steps.vars.outputs.sha_short }}`),
which is why all 242 tags are 7-character hashes and the newest release is
named "2024-10-12-e76674a". The deploy job carrying it was commented out in
ab2258a and ca3df18 (2024-11-20, "remove PDF flow"), so releases stopped
there. Since then the header has advertised a hash from October 2024 on a site
that is redeployed on every push to main.

Hide the version fact and keep stars and forks, which are accurate (234/209,
matching the API). The docs are continuously deployed and carry no version, so
there is nothing meaningful to put in its place.

Done in CSS rather than by overriding the source.html partial: material injects
the facts client-side, building `md-source__fact--<type>` in JS, so dropping
them in the template would remove stars and forks too. The facts are a flex row
with `gap` and per-item icons, no textual separators, so hiding one leaves no
gap or stray glyph.

Verified with a local `mkdocs build`: the rule ships in site/css/armbian-extra.css
and the stylesheet is linked from the built pages.

Signed-off-by: Igor Pecovnik <igor@armbian.com>
@github-actions github-actions Bot added size/small PR with less then 50 lines Needs review Seeking for review and removed size/small PR with less then 50 lines labels Sep 1, 2026
@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: e936cd96-e0f2-45b2-bf45-13625681f55b

📥 Commits

Reviewing files that changed from the base of the PR and between 0514571 and 1c2bd26.

📒 Files selected for processing (1)
  • docs/css/armbian-extra.css

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


Walkthrough

The documentation stylesheet adds a .md-source__fact--version rule. The rule hides the repository version chip in the header. Stars and forks remain visible.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 1c2bd

This localized CSS change hides the stale repository version chip while preserving stars and forks; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: hiding the stale version chip in the repository header.
Description check ✅ Passed The description directly explains the stale version chip, the CSS change, the preservation of stars and forks, and the build verification.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/hide-stale-version-chip

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

github-actions Bot pushed a commit that referenced this pull request Sep 1, 2026
@igorpecovnik
igorpecovnik merged commit 6b4b5df into main Sep 1, 2026
6 checks passed
@igorpecovnik
igorpecovnik deleted the docs/hide-stale-version-chip branch September 1, 2026 04:04
github-actions Bot pushed a commit that referenced this pull request Sep 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs review Seeking for review

Development

Successfully merging this pull request may close these issues.

1 participant