feat: embed TypeDoc documentation within admin UI #2248
+27
−6
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
Display TypeDoc API documentation in an iframe within the admin UI instead of opening in a new browser tab. Users can now browse documentation while maintaining access to the admin navbar and sidebar navigation. Changes: - Add EmbeddedDocs component with responsive iframe - Add /documentation route in Full.js - Update Sidebar.js to use internal route instead of external link The original /documentation/ endpoint remains accessible for direct access. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
/documentation/endpoint remains accessible for direct accessChanges
EmbeddedDocs.jscalc(100vh - 55px))Full.js/documentationroute before login routeSidebar.jstarget: '_blank') to internal routeValidation Evidence
Comprehensive browser automation testing was performed with 14 screenshots captured:
Baseline (Before Changes)
Core Feature Validation
Direct URL & Compatibility
admin/#/documentationloads correctly ✓/documentation/URL still works standalone ✓Responsive & Edge Cases
Build Verification
npm run buildcompletes with no errors ✓Test Checklist
admin/#/documentation→ loads correctly/documentation/→ still worksScreenshots
Screenshots were captured during automated testing. Key validations:
🤖 Generated with Claude Code