Skip to content

LCORE-1374: contribution guide on GH pages#1220

Merged
tisnik merged 1 commit intolightspeed-core:mainfrom
tisnik:lcore-1374-contribution-guide
Feb 25, 2026
Merged

LCORE-1374: contribution guide on GH pages#1220
tisnik merged 1 commit intolightspeed-core:mainfrom
tisnik:lcore-1374-contribution-guide

Conversation

@tisnik
Copy link
Contributor

@tisnik tisnik commented Feb 25, 2026

Description

LCORE-1374: contribution guide on GH pages

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-1374

Summary by CodeRabbit

  • Documentation
    • Updated the Contributing guide link in documentation files to point to the new guide location.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 25, 2026

Walkthrough

Updated the Contributing guide link references in documentation files from the old path CONTRIBUTING.html to the new path contributing_guide.html. Changes affect only the link paths with no modifications to content or structure.

Changes

Cohort / File(s) Summary
Documentation links
docs/README.md, docs/index.md
Updated Contributing guide link path from CONTRIBUTING.html to contributing_guide.html in both documentation files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 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 refers to adding a contribution guide on GitHub Pages, which aligns with updating documentation links in README and index files to point to the new contributing_guide.html page.
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.

♻️ Duplicate comments (1)
docs/README.md (1)

36-36: Same link update as docs/index.md — same verification applies.

The concern about contributing_guide.html needing a corresponding source file is identical to the one flagged in docs/index.md.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/README.md` at line 36, The README link points to contributing_guide.html
which may not have a corresponding source like contributing_guide.md (same issue
flagged in docs/index.md); either add the source file that generates
contributing_guide.html or update the link to the correct existing source/HTML
(e.g., contributing_guide.md or the correct path used in docs/index.md) so the
reference resolves; locate references to "contributing_guide.html" in
docs/README.md and docs/index.md and make them consistent with the actual
documentation source and build output.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@docs/README.md`:
- Line 36: The README link points to contributing_guide.html which may not have
a corresponding source like contributing_guide.md (same issue flagged in
docs/index.md); either add the source file that generates
contributing_guide.html or update the link to the correct existing source/HTML
(e.g., contributing_guide.md or the correct path used in docs/index.md) so the
reference resolves; locate references to "contributing_guide.html" in
docs/README.md and docs/index.md and make them consistent with the actual
documentation source and build output.

ℹ️ 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 f6aa46b and 93c85d5.

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

@tisnik tisnik merged commit 9af1c06 into lightspeed-core:main Feb 25, 2026
22 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Feb 25, 2026
16 tasks
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