Skip to content

docs: update quickstart docs#132

Merged
HeadHunter483 merged 1 commit intomainfrom
0-update-docs
Sep 14, 2025
Merged

docs: update quickstart docs#132
HeadHunter483 merged 1 commit intomainfrom
0-update-docs

Conversation

@HeadHunter483
Copy link
Contributor

@HeadHunter483 HeadHunter483 commented Sep 14, 2025

Description

Update for quickstart docs.


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

Summary by CodeRabbit

  • Documentation
    • Updated Quickstart (EN and RU) with direct links to hosted configuration and docker-compose resources.
    • Added an example frontend service (seq-ui-fe) to the docker-compose snippet, including default image and port mapping 5173:80.
    • Clarified instructions for running seq-db alongside seq-ui by referencing online configs instead of local files.

@coderabbitai
Copy link

coderabbitai bot commented Sep 14, 2025

📝 Walkthrough

Walkthrough

Quickstart docs (EN and RU) update references to seq-ui config and docker-compose files with GitHub links and extend the docker-compose example to include a new seq-ui-fe service (ghcr.io/ozontech/seq-ui-fe:latest) exposing port 5173:80.

Changes

Cohort / File(s) Summary
Quickstart docs (EN)
`docs/en/01-quickstart.md`
Converted plain filenames to hyperlinks for config.seq-ui.yaml and docker-compose.seq-ui.yaml; added seq-ui-fe service to the docker-compose snippet with port 5173:80.
Quickstart docs (RU)
`docs/ru/01-quickstart.md`
Updated references to use hyperlinks to config.seq-ui.yaml and docker-compose.seq-ui.yaml; inserted seq-ui-fe service (ghcr.io/ozontech/seq-ui-fe:latest) before seq-db-proxy with port 5173:80.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • forshev
  • ssnd

Pre-merge checks and finishing touches

✅ 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: update quickstart docs" correctly indicates that the PR is a documentation change to the quickstart and aligns with the changeset (updating links and adding a seq-ui-fe service). It is concise and relevant, though somewhat generic because it does not call out the added seq-ui-fe service explicitly.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 0-update-docs

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (4)
docs/en/01-quickstart.md (2)

149-149: Pin the config link to a tag/commit for reproducibility.

Linking to main can drift and break the quickstart over time. Prefer a permalink to a release tag or commit.


204-207: Front-end wiring: add start-order and note API base/CORS.

  • Consider start-order so FE comes up after BE.
  • Call out how FE reaches seq-ui (API base URL or CORS), or this may 404/CORS-fail for users.

Apply minimal start-order tweak:

   seq-ui-fe:
     image: ghcr.io/ozontech/seq-ui-fe:latest
     ports:
       - "5173:80"
+    depends_on:
+      - seq-ui
docs/ru/01-quickstart.md (2)

146-146: Зафиксируйте ссылку на конфиг на тег/коммит.

Ссылка на main со временем «поплывёт». Лучше использовать permalink на релизный тег или конкретный коммит.


201-205: Связка фронтенда с бэкендом: порядок старта и базовый URL API.

  • Добавьте порядок старта FE после seq-ui.
  • В тексте кратко уточните, как FE обращается к seq-ui (base URL/CORS), иначе возможны 404/CORS.

Минимальное изменение:

   seq-ui-fe:
     image: ghcr.io/ozontech/seq-ui-fe:latest
     ports:
       - "5173:80"
+    depends_on:
+      - seq-ui
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 688a847 and b93a7ee.

📒 Files selected for processing (2)
  • docs/en/01-quickstart.md (3 hunks)
  • docs/ru/01-quickstart.md (3 hunks)
⏰ 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
🔇 Additional comments (2)
docs/en/01-quickstart.md (1)

189-189: Pin the docker-compose link and verify path.

Same concern: link to a tag/commit. Also confirm quickstart/docker-compose.seq-ui.yaml exists in the repo.

docs/ru/01-quickstart.md (1)

186-186: Зафиксируйте ссылку на docker-compose и проверьте путь.

Аналогично: используйте тег/коммит. Также убедитесь, что quickstart/docker-compose.seq-ui.yaml есть в репозитории.

@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.48%. Comparing base (688a847) to head (b93a7ee).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #132      +/-   ##
==========================================
- Coverage   71.49%   71.48%   -0.02%     
==========================================
  Files         201      201              
  Lines       18170    18170              
==========================================
- Hits        12991    12988       -3     
- Misses       4459     4461       +2     
- Partials      720      721       +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.

@HeadHunter483 HeadHunter483 merged commit 1e717bc into main Sep 14, 2025
9 checks passed
@HeadHunter483 HeadHunter483 deleted the 0-update-docs branch September 14, 2025 12:50
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.

5 participants