Skip to content

Add per-page icons to docs sidebar#5997

Merged
aaravgarg merged 1 commit into
mainfrom
atlas/docs-sidebar-icons
Mar 24, 2026
Merged

Add per-page icons to docs sidebar#5997
aaravgarg merged 1 commit into
mainfrom
atlas/docs-sidebar-icons

Conversation

@atlas-agent-omi
Copy link
Copy Markdown

Adds icons to each individual page in the docs sidebar (not group headings). Each MDX file gets an icon frontmatter property.

61 pages updated with contextual icons — similar to the Supermemory docs style where every line item has its own icon.

Examples:

  • 🧠 Memories → brain
  • 🔑 API Keys → key
  • 📡 Transcription → microphone
  • 🔌 MCP → plug
  • 🛒 Buying Guide → cart-shopping
  • 🔒 Privacy → lock

Added icon frontmatter to all 61 doc pages for per-page sidebar icons:
- Get Started: book-open, play, message-dots
- Backend: server, magnifying-glass, comments, database, microphone, tower-broadcast
- SDK: cube, snake, react, swift
- Developer API: square-terminal, brain, list-check, message, key
- Apps: grid-2, terminal, link, wrench, github, slack, graduation-cap, etc.
- Hardware: circle-dot, screwdriver-wrench, bolt, gears, glasses, circuit-board
- DIY: book, cart-shopping, screwdriver
- Info: life-ring, scale-balanced, triangle-exclamation, lock
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 24, 2026

Greptile Summary

This PR adds per-page icon frontmatter to 61 MDX documentation files, giving every sidebar item its own contextual icon (e.g. brain for Memories, key for API Keys, microphone for Transcription). As part of the change, all group-level "icon" entries are removed from docs.json, shifting icon decoration entirely to individual pages.

Key changes:

  • 61 MDX files receive a new icon frontmatter field with contextually appropriate Font Awesome icon names
  • All "icon" properties on navigation groups in docs.json are removed (groups will now render without icons in the sidebar)
  • One formatting issue introduced: "doc/developer/apps/OpenSource" in docs.json has incorrect excessive indentation (~20 spaces instead of the consistent 10)
  • docs.json loses its trailing newline

Confidence Score: 4/5

  • Safe to merge after fixing the indentation typo and trailing newline in docs.json; the group icon removal is a deliberate design choice worth confirming.
  • The MDX changes are all trivially correct — adding a single icon frontmatter line to each file. The only concrete issues are in docs.json: one entry with wrong indentation (harmless to JSON parsing but inconsistent) and a missing trailing newline. The removal of group-level icons is intentional per the PR description, so it's not a bug. No logic or functional regressions are introduced.
  • docs/docs.json — indentation typo on line 101 and missing trailing newline should be fixed before merge.

Important Files Changed

Filename Overview
docs/docs.json All navigation group-level icons removed; one page entry has incorrect indentation; missing trailing newline introduced.
docs/doc/developer/apps/OpenSource.mdx Adds icon: "code-branch" to frontmatter — appropriate icon, no issues.
docs/getstartedwithomi.mdx Adds icon: "play" to frontmatter — contextually appropriate.
docs/doc/get_started/introduction.mdx Adds icon: "book-open" to frontmatter — appropriate.
docs/doc/developer/MCP.mdx Adds icon: "plug" to frontmatter — reuses the former group-level icon, appropriate.
docs/doc/developer/api/memories.mdx Adds icon: "brain" — semantically relevant to memories.
docs/doc/info/Privacy.mdx Adds icon: "lock" — appropriate for a privacy policy page.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[docs.json navigation groups] -->|Previously| B[Group-level icon on each group heading]
    A -->|After this PR| C[No icon on group headings]
    D[MDX page frontmatter] -->|Previously| E[title + description only]
    D -->|After this PR| F[title + description + icon per page]
    F --> G[Sidebar shows icon next to every page item]
    C --> H[Sidebar shows plain text group headers]
Loading

Reviews (1): Last reviewed commit: "Add icons to individual docs sidebar pag..." | Re-trigger Greptile

Comment thread docs/docs.json
"doc/developer/apps/Notifications",
"doc/developer/apps/Submitting",
"doc/developer/apps/OpenSource"
"doc/developer/apps/OpenSource"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Incorrect indentation on OpenSource entry

The "doc/developer/apps/OpenSource" entry at line 101 has about 20 leading spaces instead of the 10 used by every other page entry at the same nesting level (e.g. "doc/developer/apps/Submitting" on the line above). While JSON parsers ignore whitespace outside strings so this won't break parsing, it's inconsistent and suggests an accidental edit.

Suggested change
"doc/developer/apps/OpenSource"
"doc/developer/apps/OpenSource"

Comment thread docs/docs.json
}
}
}
} No newline at end of file
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Missing newline at end of file

The diff shows the closing } was changed to remove the trailing newline (-}\n+}), leaving the file without a POSIX-compliant end-of-file newline. Most editors and linters (including Mintlify's tooling) expect a trailing newline. Add one back to restore the original behaviour.

Suggested change
}
}

Comment thread docs/docs.json
Comment on lines 13 to 14
{
"group": "Get Started",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Group-level icons removed from all navigation groups

Every top-level and nested group entry (e.g. "Get Started", "Core Development", "Backend", "Firmware", "SDK", "Audio & Testing", "Developer API", "MCP Integration", "Build Apps", "Examples", "Hardware", "Open Source Hardware", "OmiGlass", "DIY Guide", "Info") had their "icon" field removed. This means sidebar group headers will now render without icons on the Mintlify site.

Per the PR description this is intentional (moving icons from groups to individual pages), but it's worth verifying the visual result is acceptable — Mintlify displays group headings prominently and many users rely on group icons to orient themselves in the sidebar. If the intent is to have both group and page icons, the group "icon" entries would need to be kept.

@aaravgarg aaravgarg merged commit 11e5e31 into main Mar 24, 2026
2 of 3 checks passed
@aaravgarg aaravgarg deleted the atlas/docs-sidebar-icons branch March 24, 2026 09:32
Glucksberg pushed a commit to Glucksberg/omi-local that referenced this pull request Apr 28, 2026
Adds icons to each individual page in the docs sidebar (not group
headings). Each MDX file gets an `icon` frontmatter property.

**61 pages updated** with contextual icons — similar to the Supermemory
docs style where every line item has its own icon.

Examples:
- 🧠 Memories → `brain`
- 🔑 API Keys → `key`
- 📡 Transcription → `microphone`
- 🔌 MCP → `plug`
- 🛒 Buying Guide → `cart-shopping`
- 🔒 Privacy → `lock`
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.

1 participant