quickwit-oss / quickwit-oss/quickwit

Docs that show the benefits of time pruning

Open
#3,985 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Rust
Stars
11.7k
Forks
597
Avg merge
2d 22h
Merged PRs (30d)
37

Description

My documentation idea

In https://github.com/quickwit-oss/quickwit/pull/3954 we removed the section about time pruning because the dataset used was not showcasing its benefits at all (mostly because there were to few splits).

It would be great to have an example that shows how crucial time pruning can be.

What do you all think?
👍 I would love to see it!
🚀 I would love to help!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading pull request 3954 to understand which documentation section was removed and why its dataset failed to show time-pruning benefits. Identify the relevant documentation example and design a dataset or demonstration where time pruning is visibly beneficial. Done means the documentation includes a convincing, reproducible example that clearly shows the impact.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.