Skip to content

docs: openfluids.github.io README banner - #17

Merged
ricardofrantz merged 2 commits into
mainfrom
docs/readme-banner
Nov 16, 2026
Merged

ricardofrantz merged 2 commits into
mainfrom
docs/readme-banner

Conversation

@ricardofrantz

@ricardofrantz ricardofrantz commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

README line 1 is now the banner, as every house README opens.

Proof

  • assets/readme-banner-v3.jpg added (1408 x 469 JPEG, the house hero).
  • README line 1: ![openfluids.github.io banner](https://raw.githubusercontent.com/openfluids/openfluids.github.io/main/assets/readme-banner-v3.jpg).
  • Docs only; no code changed.

View guided diff

Summary by CodeRabbit

  • Documentation
    • Added a banner image to the top of the README.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 2 files

View guided diff | Re-trigger cubic

@coderabbitai

coderabbitai Bot commented Nov 16, 2026

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The README adds an OpenFluids website banner at the top, followed by a blank line before the existing content.

Changes: README Banner

Layer / File(s) Summary
Add README banner
README.md
The README now begins with the OpenFluids website banner and a blank line.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Possibly related PRs

  • openfluids/openfluids.github.io#15: This PR also changes the README opening. Its proposed title and name-first line conflict with this PR’s banner-first layout, so the final structure depends on merge order.
Merge Risk: Minimal · up to 29a41

This is a documentation-only change that adds a README banner. No merge-blocking risk remains.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the change: a README banner for the openfluids.github.io docs. The raw summary says the README adds a banner image at the top, and the objectives confirm a banner is added as the first…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the change: a README banner for the openfluids.github.io docs. The raw summary says the README adds a banner image at the top, and the objectives confirm a banner is added as the first line. The title uses the docs: prefix and is concise, so it matches the main change.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
Simplify code

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Central YAML; Path: .coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: d8664ba2-e4db-4638-ac6a-90e506248ee9
Commits

Reviewing files that changed from the base of the PR and between 78f5c47 and 29a41fb.

Files ignored due to path filters: 1

  • assets/readme-banner-v3.jpg is excluded by !**/*.jpg
Files selected for processing: 1

  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@ricardofrantz
ricardofrantz merged commit 8865b06 into main Nov 16, 2026
5 checks passed
@ricardofrantz
ricardofrantz deleted the docs/readme-banner branch November 16, 2026 16:44
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