Skip to content

docs: add repository star count and activity badges to web UI list - #3447

Merged
nblock merged 8 commits into
juanfont:mainfrom
dotWee:feature/web-interfaces-for-headscale-with-badges
Sep 2, 2026
Merged

docs: add repository star count and activity badges to web UI list#3447
nblock merged 8 commits into
juanfont:mainfrom
dotWee:feature/web-interfaces-for-headscale-with-badges

Conversation

@dotWee

@dotWee dotWee commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

This is a very minor contribution.

The community web UI list is hard to compare at a glance: a one-line description kinda helps sub-selecting solutions, but it's hard to find a maintained one.

This change adds Shields.io badges next to each listed project:

  • GitHub star count
  • GitHub last commit

Documentation only. No code, tests, or changelog updates. Raising a GitHub issue not really worth as well.

  • have read the CONTRIBUTING.md file
  • raised a GitHub issue or discussed it on the projects chat beforehand
  • added unit tests
  • added integration tests
  • updated documentation if needed
  • updated CHANGELOG.md

Show GitHub star counts next to each community web UI so
readers can compare popularity at a glance.
Show GitHub last-commit dates next to each community web UI so
readers can tell which projects are still maintained.
@dotWee dotWee changed the title docs: add popularity and activity badges to web UI list docs: add repository star count and activity badges to web UI list Sep 1, 2026

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

Maybe useful, I'm not really sure about it yet.

Still, the same should be also applied to ref/integration/tools.md

Comment thread docs/ref/integration/web-ui.md
Render the GitHub stars shields as the flat variant
so they sit more cleanly next to the last-commit badges.
Show stars and last-commit shields for each
third-party tool, matching the web interfaces page.
Put stars and last-commit shields in the first
sub-bullet and keep the description as the second.
@dotWee

dotWee commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

Performed the following 3 actions:

  • Updated the stars badge to the flat style, like the lastCommit badge
  • Added badges to the ref/integration/tools.md page as well
  • Reformatted to bullet points, as suggested

Renders to:

image

The screenshot also shows the shields.io license badge, a commit currently not pushed, as not every project seems to have one declared.

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

Please run the mdformat prek commit hook and test it with mkdocs and not with a random markdown renderer.

Comment thread docs/ref/integration/tools.md
Use four-space nested lists with blank lines so MkDocs renders
badges and descriptions as children of each project.
@dotWee

dotWee commented Sep 2, 2026

Copy link
Copy Markdown
Contributor Author

Reformatted by mkformat and evaluated:

image

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

Please remove all the empty lines between; just indent by 4 spaces.

Keep nested badges compact so the project name, badges, and
description sit together without extra vertical gaps.
Comment thread docs/ref/integration/tools.md Outdated
Remove blank lines between entries so the badge lists read as
one block.
@nblock
nblock merged commit 89fa72e into juanfont:main Sep 2, 2026
30 checks passed
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