Skip to content

docs: fix quickstart in 01-quickstart.md#147

Merged
cheb0 merged 1 commit intomainfrom
0-fix-quickstart-docs
Sep 25, 2025
Merged

docs: fix quickstart in 01-quickstart.md#147
cheb0 merged 1 commit intomainfrom
0-fix-quickstart-docs

Conversation

@cheb0
Copy link
Member

@cheb0 cheb0 commented Sep 24, 2025

Description

Currently, the simplest quickstart doesn't work, since /seq-db-data doesn't exist inside the container. We can either:

  • simply omit the config for the data directory, since it's the first what a potential user will do and having a simpler config might be a good idea
  • create volume and map a local directory to /seq-db-data:
docker run --rm \
  -p 9002:9002 \
  -p 9004:9004 \
  -p 9200:9200 \
  -v "$(pwd)"/config.yaml:/seq-db/config.yaml \
  -v "$(pwd)"/data:/seq-db-data \
  -it ghcr.io/ozontech/seq-db:latest --mode single --config=config.yaml

  • I have read and followed all requirements in CONTRIBUTING.md;
  • I used LLM/AI assistance to make this pull request;

If you have used LLM/AI assistance please provide model name and full prompt:

Model: {{model-name}}
Prompt: {{prompt}}

Summary by CodeRabbit

  • Documentation
    • Updated Quickstart guides (EN and RU) to simplify the sample config.yaml: removed the storage.data_dir line from the storage block; mapping.path: auto remains.
    • Aligns examples with current defaults to reduce setup confusion and streamline initial configuration.
    • Clarifies that users don’t need to specify data_dir in the basic example.
    • No functional changes to the product; existing configurations are unaffected.

@cheb0 cheb0 requested review from forshev and moflotas September 24, 2025 08:28
@coderabbitai
Copy link

coderabbitai bot commented Sep 24, 2025

📝 Walkthrough

Walkthrough

Documentation updates to Quickstart guides in English and Russian: the sample config.yaml no longer includes storage.data_dir (previously /seq-db-data). The storage block is shown without data_dir, and mapping.path: auto remains. No code changes; only example configuration text in docs was adjusted.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "docs: fix quickstart in 01-quickstart.md" succinctly describes the primary change—a documentation fix to the Quickstart file—and is directly related to the changeset, making it clear and appropriate for repository history.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d4e256 and 451b930.

📒 Files selected for processing (2)
  • docs/en/01-quickstart.md (0 hunks)
  • docs/ru/01-quickstart.md (0 hunks)
💤 Files with no reviewable changes (2)
  • docs/en/01-quickstart.md
  • docs/ru/01-quickstart.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: test

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.37%. Comparing base (8d4e256) to head (451b930).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #147      +/-   ##
==========================================
- Coverage   71.42%   71.37%   -0.05%     
==========================================
  Files         200      200              
  Lines       18143    18143              
==========================================
- Hits        12958    12950       -8     
- Misses       4464     4471       +7     
- Partials      721      722       +1     

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dkharms dkharms added the documentation Improvements or additions to documentation label Sep 24, 2025
@cheb0 cheb0 merged commit 172a8d7 into main Sep 25, 2025
8 checks passed
@cheb0 cheb0 deleted the 0-fix-quickstart-docs branch September 25, 2025 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants