Skip to content

LCORE-1356: e2e tests guide nits#1244

Merged
tisnik merged 2 commits intolightspeed-core:mainfrom
tisnik:lcore-1356-e2e-tests-quide-nits
Mar 2, 2026
Merged

LCORE-1356: e2e tests guide nits#1244
tisnik merged 2 commits intolightspeed-core:mainfrom
tisnik:lcore-1356-e2e-tests-quide-nits

Conversation

@tisnik
Copy link
Contributor

@tisnik tisnik commented Mar 2, 2026

Description

LCORE-1356: e2e tests guide nits

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement
  • Benchmarks improvement

Tools used to create PR

  • Assisted-by: N/A
  • Generated by: N/A

Related Tickets & Documents

  • Related Issue #LCORE-1356

Summary by CodeRabbit

  • Documentation
    • Added an "End-to-End Tests Guide" documentation link in the Testing section.
    • Added a "List of e2e scenarios" reference alongside the new guide.
    • Improved formatting and presentation of environment variable tables, scenario tags, feature listings, and Gherkin keyword tables for clearer readability.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 2, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3073027 and c0ada30.

📒 Files selected for processing (1)
  • docs/e2e_testing.md

Walkthrough

Adds two navigation links for end-to-end testing to documentation index/README and reformats tables and text in the e2e testing guide; no functional code or public API changes.

Changes

Cohort / File(s) Summary
Docs: navigation updates
docs/README.md, docs/index.md
Added "End-to-End Tests Guide" link and a "List of e2e scenarios" entry to documentation navigation.
Docs: e2e guide formatting
docs/e2e_testing.md
Reflowed and realigned tables and textual sections (Environment Variables, Scenario Tags, Gherkin keywords, feature/file listings). Purely formatting/presentation edits; no semantic changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ 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 'LCORE-1356: e2e tests guide nits' accurately summarizes the main changes: adding links to the e2e testing guide and reformatting documentation tables.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
Contributor

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/e2e_testing.md`:
- Around line 312-318: The table under "Literals and special syntax" is
malformed: remove the extra empty columns so the table has three columns
(Syntax, Meaning, Example), and correct the "Data table" Example cell to a valid
markdown table or a simple inline example (e.g., show header and row or show how
to reference context.table) instead of the broken escaped backslashes; ensure
backticks and triple-quote examples for the "Doc string" and placeholder
examples for `{MODEL}`/`{PROVIDER}` remain properly fenced and not split across
extra columns; update the rows for "Doc string", "Data table", "Placeholders",
and "Step argument" so each row has exactly three pipe-separated cells and
renders cleanly.

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8fb6728 and 3073027.

📒 Files selected for processing (3)
  • docs/README.md
  • docs/e2e_testing.md
  • docs/index.md

@tisnik tisnik force-pushed the lcore-1356-e2e-tests-quide-nits branch from 3073027 to c0ada30 Compare March 2, 2026 09:56
@tisnik tisnik merged commit 84105b2 into lightspeed-core:main Mar 2, 2026
20 of 22 checks passed
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