Dashboard for Managing Docs #87
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
…ingStars components
…e; remove redundant description field
…and enhance commit docs fetching logic
…eTable for documentation features
…er experience and data handling
… component for better user interaction
…enhancing structure
…on pages and integrate it into the DocsEditor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a dashboard for managing documentation pages, including a drag‐and‐drop sidebar, document upload with image conversion, and updated routing and API endpoints for enhanced documentation management.
- Adds multiple drag‐and‐drop components and utilities for the sidebar and task management.
- Integrates image upload enhancements with WebP conversion in the file upload workflow.
- Updates backend API endpoints and routing to support new dashboard functionality.
Reviewed Changes
Copilot reviewed 48 out of 51 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| dashboard/src/components/features/Sidebar/utils.ts | Adds utility functions for handling draggable data in the sidebar. |
| dashboard/src/components/features/Sidebar/multipleContainerKeyboardPreset.ts | Implements customizable keyboard navigation for draggable containers. |
| dashboard/src/components/features/Sidebar/TaskCard.tsx | Introduces a task card component with delete and drag–handle support. |
| dashboard/src/components/features/Sidebar/KanbanBoard.tsx | Provides a Kanban-style board for managing sidebar items and tasks. |
| dashboard/src/components/features/Sidebar/DashboardSidebar.tsx | Implements the dashboard sidebar, fetching data via API hooks. |
| dashboard/src/components/features/Sidebar/BoardColumn.tsx | Establishes board columns with add, delete, and reorder functionalities. |
| dashboard/src/components/common/ImageUploader2/FileDrop.tsx | Updates file drop component styling for improved user experience. |
| dashboard/src/components/common/ImageUploader2/DocumentUploadModal.tsx | Enhances modal with better layout and privacy settings for document uploads. |
| dashboard/src/components/common/Checkbox/CreatableSelect.tsx | Minor fix: Adjusts conditional class application for checkbox select. |
| dashboard/src/components/common/AsyncDropdown/AsyncDropdown.tsx | Expands the async dropdown functionality with improved state management. |
| dashboard/src/App.tsx | Modifies routing to integrate the new documentation dashboard routes. |
| commit/www/commit.py | Exposes additional commit docs data via bootstrapping for the docs dashboard. |
| commit/hooks.py | Updates website route rules to align with new documentation endpoints. |
| commit/commit/doctype/commit_docs_page/commit_docs_page.py | Adds logic to capture and enqueue preview screenshots before saving pages. |
| commit/commit/doctype/commit_docs/commit_docs.py | Updates sidebar treatment and introduces a new function to manage sidebar items. |
| commit/api/preview.py | Implements asynchronous screenshot capture and preview image saving. |
| commit/api/convert_to_webp.py | Provides conversion of images to WebP format for optimized image delivery. |
Files not reviewed (3)
- commit/commit/doctype/commit_docs/commit_docs.json: Language not supported
- commit/commit/doctype/commit_docs_page/commit_docs_page.json: Language not supported
- dashboard/package.json: Language not supported
Comments suppressed due to low confidence (1)
dashboard/src/components/features/Sidebar/BoardColumn.tsx:71
- [nitpick] The filters parameter is passed as a string (title) rather than an object; consider using an object (e.g. { title: title }) to ensure proper filtering.
call.get('frappe.client.get_value', { doctype: 'Commit Docs Page', filters: title, fieldname: ['route', 'title'] })
…etter compatibility
Member
|
How soon can we publish our docs for Raven and other libraries here? We need the following blocks:
|
Member
Author
For Now We have Youtube embeds and Code Blocks, will add API block soon |
…nBoard components
…nal input fields and styling improvements
… Sidebar components for improved visibility control
…r improved markdown rendering
Member
Author
|
Attaching Recording of complete flow Screen.Recording.2025-03-31.at.1.49.29.PM.mov |
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.
Documentation Should Have dashboard to manage the docs page, It can have analytics , configurations, settings
1. Dashboard - first page of dashboard it will have analytics and info of docs
2. Editor - editor is important asset of dashboard it have list of pages we have in our docs, it the section where user can manage pages, create, delete edit
3. Sidebar - It is the section where user can manage how to showcase actual docs sidebar , Parent Section sequence everything can handle here
4. Navbar and Footer - User can manage the Navbar Button (Buttons, Menu Buttons), Can Manage Footer Items
5. Settings
Actual Docs Site look like this