fix(docs,ui): repair docs navigation and the collapsed admin sidebar - #345
Merged
Conversation
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 does this PR do?
Fixes three navigation bugs — two on the docs site, one in the admin UI — that
each made part of the product hard to move around in. Also adds a step-by-step
SigNoz logs guide.
Why?
All three were reported by users, and they share a shape: navigation that
looked fine but silently went nowhere.
reading.
heavily; every one of those links quietly failed. A follow-up report showed
links to numbered headings failed for a second, unrelated reason, which
affected 13 links across 5 files.
linked only to that group's first item, so collapsing the rail made
everything else unreachable. Users could not tell items were missing —
the rail looked complete.
How to test
Docs site — serve
versus-incident/src/and check:expands the section containing it.
agent/data-sources/prometheus), click one:it scrolls to the section and the URL gains
?id=….enterprise/metrics/signoz→"What it discovers"): it scrolls rather than sitting still.
?id=…URL directly into the address bar: it lands on the section,not the top.
Admin UI
Then collapse the rail and hover a group icon: the flyout lists every item in
that group. Move diagonally into the panel — it stays open. Tab to a group
icon: the flyout opens;
Escapecloses it. Check a bottom group (Manage)where the panel is clamped against the viewport edge.
Type of change
Checklist
go test ./...passes locally — no Go code changed; not rungo vet ./...is clean — no Go code changed; not rungofmt'd — no Go code changedsrc/if behavior changesROADMAP.mdif this closes a roadmap item — not a roadmap item