Repository navigation
docs: give every CLI page a Lucide icon, as on docs.bronto.io - #248
Merged
Merged
Conversation
The official docs restyle (bronto-docs 55190bf) added sidebar icons and coloured card icons by editing cli/ there directly, so each release sync from this repo would remove them again. Move them here instead: - docs.json uses the Lucide icon library, like the official docs. - Hand-written pages carry an icon in their frontmatter, and the index cards use the restyle's Lucide icons and colours. - docgen writes an icon into every generated reference page and the Commands sidebar group. commandIcons must name exactly the top-level commands, so a new command fails `make docs-reference` until it has one. Assisted-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The review identifies no active issues with the documentation icon-styling changes.
No open issues 🎉
What changed in this PR
Keeps the CLI documentation’s icon styling in this repository so release syncs preserve the official site’s appearance. CLI runtime behavior is unchanged.
Changes:
- Selects Lucide icons, adds sidebar icons to documentation pages, and styles landing-page cards.
- Updates docgen to emit icons and reject missing or stale command-icon entries, with tests.
- Updates documentation guidance for page icons and card styling.
| File | Description |
|---|---|
internal/tools/docgen/main.go |
Generates page and group icons; validates command-icon coverage. |
internal/tools/docgen/main_test.go |
Tests complete coverage and rejection of missing or stale entries. |
docs/docs.json |
Selects the Lucide icon library. |
docs/cli/troubleshooting.mdx |
Adds life-buoy page icon. |
docs/cli/reference/output-formats.mdx |
Adds table page icon. |
docs/cli/reference/exit-codes.mdx |
Adds octagon-alert page icon. |
docs/cli/reference/environment-variables.mdx |
Adds variable page icon. |
docs/cli/reference/commands/widgets.mdx |
Adds generated layout-grid icon. |
docs/cli/reference/commands/webhooks.mdx |
Adds generated webhook icon. |
docs/cli/reference/commands/version.mdx |
Adds generated tag icon. |
docs/cli/reference/commands/users.mdx |
Adds generated users icon. |
docs/cli/reference/commands/usage.mdx |
Adds generated chart-column icon. |
docs/cli/reference/commands/traces.mdx |
Adds generated waypoints icon. |
docs/cli/reference/commands/tail.mdx |
Adds generated activity icon. |
docs/cli/reference/commands/slack.mdx |
Adds generated message-square-text icon. |
docs/cli/reference/commands/send.mdx |
Adds generated send icon. |
docs/cli/reference/commands/search.mdx |
Adds generated search icon. |
docs/cli/reference/commands/saved-searches.mdx |
Adds generated bookmark icon. |
docs/cli/reference/commands/roles.mdx |
Adds generated user-cog icon. |
docs/cli/reference/commands/repl.mdx |
Adds generated square-terminal icon. |
docs/cli/reference/commands/query.mdx |
Adds generated search-code icon. |
docs/cli/reference/commands/plugins.mdx |
Adds generated puzzle icon. |
docs/cli/reference/commands/ping.mdx |
Adds generated radio icon. |
docs/cli/reference/commands/permissions.mdx |
Adds generated shield-check icon. |
docs/cli/reference/commands/parsers.mdx |
Adds generated code icon. |
docs/cli/reference/commands/navigation.json |
Adds terminal icon to the Commands group. |
docs/cli/reference/commands/monitors.mdx |
Adds generated bell-ring icon. |
docs/cli/reference/commands/metrics.mdx |
Adds generated chart-line icon. |
docs/cli/reference/commands/login.mdx |
Adds generated log-in icon. |
docs/cli/reference/commands/log-views.mdx |
Adds generated eye icon. |
docs/cli/reference/commands/limits.mdx |
Adds generated gauge icon. |
docs/cli/reference/commands/index.mdx |
Adds generated list icon. |
docs/cli/reference/commands/groups.mdx |
Adds generated users icon. |
docs/cli/reference/commands/global-flags.mdx |
Adds generated flag icon. |
docs/cli/reference/commands/forward-configs.mdx |
Adds generated forward icon. |
docs/cli/reference/commands/fields.mdx |
Adds generated columns-3 icon. |
docs/cli/reference/commands/exports.mdx |
Adds generated file-output icon. |
docs/cli/reference/commands/encryption-keys.mdx |
Adds generated lock icon. |
docs/cli/reference/commands/datasets.mdx |
Adds generated database icon. |
docs/cli/reference/commands/dashboards.mdx |
Adds generated layout-dashboard icon. |
docs/cli/reference/commands/context.mdx |
Adds generated info icon. |
docs/cli/reference/commands/config.mdx |
Adds generated settings icon. |
docs/cli/reference/commands/completion.mdx |
Adds generated text-cursor-input icon. |
docs/cli/reference/commands/collections.mdx |
Adds generated library icon. |
docs/cli/reference/commands/auth.mdx |
Adds generated log-in icon. |
docs/cli/reference/commands/ask.mdx |
Adds generated message-circle-question-mark icon. |
docs/cli/reference/commands/api.mdx |
Adds generated braces icon. |
docs/cli/reference/commands/api-keys.mdx |
Adds generated key-round icon. |
docs/cli/index.mdx |
Adds page icon and coloured Lucide card icons. |
docs/cli/guides/traces.mdx |
Adds waypoints page icon. |
docs/cli/guides/sending-data.mdx |
Adds send page icon. |
docs/cli/guides/searching.mdx |
Adds search page icon. |
docs/cli/guides/scripting.mdx |
Adds square-terminal page icon. |
docs/cli/guides/resources.mdx |
Adds boxes page icon. |
docs/cli/guides/monitors-and-dashboards.mdx |
Adds layout-dashboard page icon. |
docs/cli/guides/live-tail.mdx |
Adds activity page icon. |
docs/cli/guides/exports.mdx |
Adds file-output page icon. |
docs/cli/guides/ci-cd.mdx |
Adds git-branch page icon. |
docs/cli/guides/ask.mdx |
Adds message-circle-question-mark page icon. |
docs/cli/guides/access-management.mdx |
Adds user-check page icon. |
docs/cli/getting-started/quickstart.mdx |
Adds rocket page icon. |
docs/cli/getting-started/install.mdx |
Adds download page icon. |
docs/cli/getting-started/authentication.mdx |
Adds log-in page icon. |
docs/cli/extend/plugins.mdx |
Adds puzzle page icon. |
docs/cli/extend/api.mdx |
Adds braces page icon. |
docs/cli/configuration/telemetry.mdx |
Adds radio-tower page icon. |
docs/cli/configuration/shell-completion.mdx |
Adds text-cursor-input page icon. |
docs/cli/configuration/environments.mdx |
Adds layers page icon. |
docs/cli/configuration/config-files.mdx |
Adds file-cog page icon. |
docs/AGENTS.md |
Documents Lucide page icons, command mappings, and card colours. |
Review effort: Balanced
/core-features/log-search/query-syntax doesn't exist on docs.bronto.io; the syntax reference every other page links to is /query-syntax/search-syntax. Reported by Copilot on brontoio/bronto-docs#195. Assisted-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Every CLI docs page now has a sidebar icon, and the landing-page cards use coloured Lucide icons, matching the official docs at docs.bronto.io/cli:
docs/docs.jsonuses the Lucide icon library, like the official docs.Hand-written pages carry
icon:in their frontmatter, and theindex.mdxcards use the restyle's icons and colours.docgen writes an icon into every generated reference page and into the Commands sidebar group.
commandIconsmust name exactly the documented top-level commands, so a new command failsmake docs-referenceuntil it gets an icon (tested ininternal/tools/docgen/main_test.go).docs/AGENTS.mdsays icons are Lucide names (it said Font Awesome) and explains page icons.Also fixes the query-language link in the dashboard manifest guide (
/core-features/log-search/query-syntaxdoes not exist; now/query-syntax/search-syntax), reported by Copilot on brontoio/bronto-docs#195.Why
The official docs restyle (brontoio/bronto-docs 55190bf) added these icons by editing
cli/in the official repo directly.scripts/sync-official-docs.shreplaces that folder on every release, so syncing v0.10.0 would remove all 65 page icons and the card styling. Keeping them here makes the sync keep them too.Every icon and card was compared file by file against the official docs'
main, and they match exactly. After this merges, the v0.10.0 docs sync runs frommain, which is v0.10.0 plus this change.Verification
make testgreenGOTOOLCHAIN=go1.26.11 make lintgreenmake coveragegate passes (88.3% vs 87.4% baseline)docs/cli/;make docs-reference-checkandmake docs-validate(strict build and link check) pass🤖 Generated with Claude Code