docs: structure documentations #387
Open
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
Reviewer's GuideThis PR restructures the documentation into a layered guide by reorganizing files into Getting Started, Core Concepts, Features, and Advanced Usage directories, updating links and image paths, and adding new guides for installation, architecture, coordinate systems, and more. Flow diagram for the new documentation structureflowchart TD
A[README.md] --> B[doc/getting_started/]
A --> C[doc/core_concepts/]
A --> D[doc/features/]
A --> E[doc/advanced_usage/]
B --> B1[installation.md]
B --> B2[basic_usage.md]
B --> B3[chart_types.md]
B --> B4[configuration.md]
B --> B5[advanced_features.md]
C --> C1[architecture.md]
C --> C2[coordinate_system.md]
C --> C3[how_chart_lib_works.md]
C --> C4[rendering_pipeline.md]
C --> C5[interactive_layer.md]
D --> D1[annotations.md]
D --> D2[markers.md]
D --> D3[crosshair.md]
D --> D4[indicators/overview.md]
D --> D5[drawing_tools/overview.md]
E --> E1[custom_themes.md]
E --> E2[custom_indicators.md]
Flow diagram for updated documentation navigationflowchart TD
A[Getting Started]
B[Core Concepts]
C[Features]
D[Advanced Usage]
A --> A1[Installation]
A --> A2[Basic Usage]
A --> A3[Chart Types]
A --> A4[Configuration]
A --> A5[Advanced Features]
B --> B1[Architecture]
B --> B2[Coordinate System]
B --> B3[Rendering Pipeline]
B --> B4[How Chart Library Works]
B --> B5[Interactive Layer]
C --> C1[Annotations]
C --> C2[Markers]
C --> C3[Crosshair]
C --> C4[Indicators]
C --> C5[Drawing Tools]
D --> D1[Custom Themes]
D --> D2[Custom Indicators]
Flow diagram for updated image and link referencingflowchart TD
A[Old doc/ paths] -->|Moved| B[doc/core_concepts/]
A -->|Moved| C[doc/getting_started/]
A -->|Moved| D[doc/features/]
A -->|Moved| E[doc/advanced_usage/]
B --> F[../images/ and ../diagrams/ for images]
C --> F
D --> F
E --> F
Flow diagram for updated README documentation linksflowchart TD
A[README.md]
A --> B[doc/core_concepts/how_chart_lib_works.md]
A --> C[doc/data_series.png]
A --> D[doc/data_painters.png]
A --> E[doc/drawing_tools.md]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @ramin-deriv - I've reviewed your changes - here's some feedback:
- The root README still has links (e.g., to data_series.png) that point to the old paths—please update all top-level links and images to match the new folder hierarchy.
- Manually maintaining a huge table of contents across multiple subfolders is error-prone—consider automating TOC generation or consolidating repeated file lists to reduce link breakages.
- Some sections use inconsistent folder naming (core_concepts vs features vs advanced_usage)—standardize directory names and file placement for clearer navigation.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The root README still has links (e.g., to data_series.png) that point to the old paths—please update all top-level links and images to match the new folder hierarchy.
- Manually maintaining a huge table of contents across multiple subfolders is error-prone—consider automating TOC generation or consolidating repeated file lists to reduce link breakages.
- Some sections use inconsistent folder naming (core_concepts vs features vs advanced_usage)—standardize directory names and file placement for clearer navigation.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Clickup link:
Fixes issue: #
This PR contains the following changes:
Developers Note (Optional)
Pre-launch Checklist (For PR creator)
As a creator of this PR:
Reviewers
Pre-launch Checklist (For Reviewers)
As a reviewer I ensure that:
Pre-launch Checklist (For QA)
Pre-launch Checklist (For Maintainer)
Summary by Sourcery
Restructure and reorganize the project documentation into logical subdirectories, update all relative links and image paths, and introduce new guide files to improve navigation and coverage.
Enhancements:
doc/core_conceptsand feature guides intodoc/features,doc/getting_started, anddoc/advanced_usagedirectoriesREADME.mdwith updated table of contents and links to reorganized docs