Skip to content

[DOC] Improve documentation homepage with feature overview and quick example#2177

Open
vinitjain2005 wants to merge 2 commits intosktime:mainfrom
vinitjain2005:improve-doc-homepages
Open

[DOC] Improve documentation homepage with feature overview and quick example#2177
vinitjain2005 wants to merge 2 commits intosktime:mainfrom
vinitjain2005:improve-doc-homepages

Conversation

@vinitjain2005
Copy link
Contributor

Reference Issues/PRs

Closes #2176

What does this implement/fix? Explain your changes.

This PR improves the documentation homepage in docs/source/index.rst.

Changes made:

  • Added a Key Features section to highlight the main capabilities of the library.
  • Added a Quick Example section to help new users understand the basic workflow.
  • Fixed wording and consistency issues such as replacing timeseries with time series.
  • Corrected a small grammar issue in the installation sentence.

These updates improve readability and make onboarding easier for first-time users.

What should a reviewer concentrate their feedback on?

  • Whether the new Key Features section is appropriate for the documentation landing page.
  • Whether the Quick Example clearly demonstrates a minimal usage workflow.
  • Wording, formatting, and placement of the new documentation sections in docs/source/index.rst.

Did you add any tests for the change?

No new tests were added because this PR only updates documentation.

Any other comments?

This is a documentation-only change intended to improve the homepage experience for new users and contributors.

PR checklist

  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.
  • Added/modified tests
  • Used pre-commit hooks when committing to ensure that code is compliant with hooks. Install hooks with pre-commit install.
    To run hooks independent of commit, execute pre-commit run --all-files

Github: @vinitjain2005

@vinitjain2005
Copy link
Contributor Author

vinitjain2005 commented Mar 12, 2026

@phoeenniixx @PranavBhatP @benHeid @fkiraly @fnhirwa @jdb78 @yarnabrina please review and merge

@codecov
Copy link

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@1a19279). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2177   +/-   ##
=======================================
  Coverage        ?   86.62%           
=======================================
  Files           ?      165           
  Lines           ?     9736           
  Branches        ?        0           
=======================================
  Hits            ?     8434           
  Misses          ?     1302           
  Partials        ?        0           
Flag Coverage Δ
cpu 86.62% <ø> (?)
pytest 86.62% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

Improve documentation homepage with quick example and clearer feature overview

1 participant