Skip to content

docs: structure documentations #387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

ramin-deriv
Copy link
Contributor

@ramin-deriv ramin-deriv commented May 29, 2025

Clickup link:
Fixes issue: #

This PR contains the following changes:

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

Developers Note (Optional)

Pre-launch Checklist (For PR creator)

As a creator of this PR:

  • ✍️ I have included clickup id and package/app_name in the PR title.
  • 👁️ I have gone through the code and removed any temporary changes (commented lines, prints, debug statements etc.).
  • ⚒️ I have fixed any errors/warnings shown by the analyzer/linter.
  • 📝 I have added documentation, comments and logging wherever required.
  • 🧪 I have added necessary tests for these changes.
  • 🔎 I have ensured all existing tests are passing.

Reviewers

Pre-launch Checklist (For Reviewers)

As a reviewer I ensure that:

  • ✴️ This PR follows the standard PR template.
  • 🪩 The information in this PR properly reflects the code changes.
  • 🧪 All the necessary tests for this PR's are passing.

Pre-launch Checklist (For QA)

  • 👌 It passes the acceptance criteria.

Pre-launch Checklist (For Maintainer)

  • [MAINTAINER_NAME] I make sure this PR fulfills its purpose.

Summary by Sourcery

Restructure the project documentation into a comprehensive, multi-layered guide covering installation, basic usage, chart types, configuration, core concepts, features, and advanced usage.

Enhancements:

  • Organize documentation into logical sections for easier navigation and discovery

Documentation:

  • Add Getting Started guides (installation, basic usage, chart types, configuration)
  • Add Core Concepts guides (architecture, data models, coordinate system, rendering pipeline)
  • Add Features guides (annotations, markers, crosshair, technical indicators overview, drawing tools overview)
  • Add Advanced Usage guides (real-time data updates, performance optimization, custom themes)
  • Update README to reflect the new documentation structure and table of contents

Copy link

sourcery-ai bot commented May 29, 2025

Reviewer's Guide

This PR establishes a comprehensive, modular documentation site for the Deriv Chart library by adding a structured set of Markdown files organized into “Getting Started,” “Core Concepts,” “Features,” and “Advanced Usage” sections (plus a root README). Each file focuses on a specific topic—ranging from basic setup and chart types to the rendering pipeline, data models, real-time data handling, and theming—providing a clear, navigable documentation hierarchy.

File-Level Changes

Change Details Files
Add Getting Started guides
  • Basic usage overview
  • Chart types reference
  • Configuration options
  • Installation instructions
doc/getting_started/basic_usage.md
doc/getting_started/chart_types.md
doc/getting_started/configuration.md
doc/getting_started/installation.md
Introduce core concepts section
  • Describe overall architecture
  • Explain coordinate system
  • Detail data models
  • Outline rendering pipeline
doc/core_concepts/architecture.md
doc/core_concepts/coordinate_system.md
doc/core_concepts/data_models.md
doc/core_concepts/rendering_pipeline.md
Document library features
  • Annotations guide
  • Markers guide
  • Crosshair guide
  • Technical indicators overview
  • Drawing tools overview
doc/features/annotations.md
doc/features/markers.md
doc/features/crosshair.md
doc/features/indicators/overview.md
doc/features/drawing_tools/overview.md
Provide advanced usage tutorials
  • Real-time data handling
  • Performance optimization techniques
  • Custom theme creation
doc/advanced_usage/real_time_data.md
doc/advanced_usage/performance_optimization.md
doc/advanced_usage/custom_themes.md
Add root index and installation guide
  • Root README with site structure
  • Installation and setup instructions
doc/README.md
doc/getting_started/installation.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant