docs: add documentation for themes and common config options #3243
Conversation
- Document the themes.enabled configuration for dark mode toggle - Add themes config to the example JSON file - Document common configuration options (dependencies, monitor, linkPatterns) - Clarify the nested object structure required for configuration Signed-off-by: Jonah Kowall <[email protected]>
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for UI configuration options, with a focus on the previously undocumented themes.enabled feature that enables dark mode support.
Key Changes:
- Added a "Common Configuration Options" section to README.md documenting themes, dependencies, monitor, and link patterns configuration
- Updated the example configuration file to include the
themesconfiguration
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/jaeger-ui/README.md | Added detailed documentation for common configuration options including themes (dark mode), dependencies (System Architecture), monitor (Service Performance Monitoring), and link patterns with usage examples |
| packages/jaeger-ui/jaeger-ui.config.example.json | Added themes.enabled configuration to demonstrate the theme toggle feature |
I have completed my review of this pull request. The documentation changes are accurate, well-structured, and correctly describe the configuration options as defined in src/types/config.tsx. All code examples match the actual configuration structure, and the cross-references are valid. No issues were identified in the proposed changes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3243 +/- ##
=======================================
Coverage 97.83% 97.83%
=======================================
Files 261 261
Lines 8209 8209
Branches 2178 2178
=======================================
Hits 8031 8031
Misses 175 175
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jkowall
added
documentation
changelog:skip
|
|
||
| ### Common Configuration Options | ||
|
|
||
| #### Themes (Dark Mode) |
There was a problem hiding this comment.
we should either have all docs here or in https://www.jaegertracing.io/docs/2.13/deployment/frontend-ui/, the split brain situation is not good
2 participants
Summary
This PR adds documentation for the UI configuration options, particularly the themes/dark mode feature.
Changes
README.md: Added a new "Common Configuration Options" section documenting:
themes.enabledjaeger-ui.config.example.json: Added the
themesconfiguration to the example fileWhy
The
themes.enabledconfiguration wasn't documented, which could lead to confusion (e.g., usingenableThemes: trueinstead of the correct nested structurethemes: { enabled: true }).Testing
Documentation only - no code changes.