[PR #23462] Fix API documentation layout and dark mode contrast issues #30275

Closed
opened 2026-02-21 20:47:11 -05:00 by yindo · 0 comments
Owner

Original Pull Request: https://github.com/langgenius/dify/pull/23462

State: closed
Merged: Yes


[!IMPORTANT]

  1. Make sure you have read our contribution guidelines
  2. Ensure there is an associated issue and you have been assigned to it
  3. Use the correct syntax to link this PR: Fixes #23461.

Summary

This PR addresses layout and usability issues in the API documentation interface that affect user experience, particularly in dark mode. The changes include:

  1. Fixed horizontal divider overflow: Added explicit width constraints to <hr> elements in API documentation templates to prevent them from extending beyond container boundaries
  2. Improved dark mode contrast: Enhanced TOC navigation panels with borders and appropriate shadows for better visual separation from main content
  3. Corrected TypeScript types: Fixed type mismatch in containerRef prop to resolve compilation errors
  4. Added MDX type declarations: Added TypeScript module declarations for MDX files to prevent import errors

The fixes are applied consistently across both dataset API documentation (/datasets API tab) and app development documentation (/apps/{id}/develop) interfaces.

Fixes #23461

Screenshots

Before After
Horizontal rules extending beyond containers, poor TOC contrast in dark mode Properly contained dividers, clearly distinguished TOC panels with borders and enhanced shadows

Checklist

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods
**Original Pull Request:** https://github.com/langgenius/dify/pull/23462 **State:** closed **Merged:** Yes --- > [\!IMPORTANT] > > 1. Make sure you have read our [contribution guidelines](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md) > 2. Ensure there is an associated issue and you have been assigned to it > 3. Use the correct syntax to link this PR: `Fixes #23461`. ## Summary This PR addresses layout and usability issues in the API documentation interface that affect user experience, particularly in dark mode. The changes include: 1. **Fixed horizontal divider overflow**: Added explicit width constraints to `<hr>` elements in API documentation templates to prevent them from extending beyond container boundaries 2. **Improved dark mode contrast**: Enhanced TOC navigation panels with borders and appropriate shadows for better visual separation from main content 3. **Corrected TypeScript types**: Fixed type mismatch in `containerRef` prop to resolve compilation errors 4. **Added MDX type declarations**: Added TypeScript module declarations for MDX files to prevent import errors The fixes are applied consistently across both dataset API documentation (`/datasets` API tab) and app development documentation (`/apps/{id}/develop`) interfaces. Fixes #23461 ## Screenshots | Before | After | |--------|-------| | Horizontal rules extending beyond containers, poor TOC contrast in dark mode | Properly contained dividers, clearly distinguished TOC panels with borders and enhanced shadows | ## Checklist - [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) - [x] I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos\!) - [x] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change. - [x] I've updated the documentation accordingly. - [x] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods
yindo added the pull-request label 2026-02-21 20:47:11 -05:00
yindo closed this issue 2026-02-21 20:47:11 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#30275