Add assets

[alexkorovko]

Summary by CodeRabbit

• Documentation
  • Updated the README with a new “Gallery” section showcasing example visuals, including sphere pose-graph refinement and Kepler orbit fitting, with centered images and descriptive bullet points.
• Chores
  • Updated repository settings to manage GIF assets via Git LFS.
  • Added ignore rules for local visualization outputs and rendered videos.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Enterprise

Run ID: e1f3874f-5c8b-4085-a96b-11b0b5aaf3d7

📥 Commits

Reviewing files that changed from the base of the PR and between f68d97a and b49bb49.

⛔ Files ignored due to path filters (2)

• assets/kepler_orbits.gif is excluded by !**/*.gif
• assets/sphere_refine.gif is excluded by !**/*.gif

📒 Files selected for processing (3)

• .gitattributes
• .gitignore
• README.md

✅ Files skipped from review due to trivial changes (3)

• .gitattributes
• .gitignore
• README.md

---

📝 Walkthrough

Walkthrough

A new ## Gallery section is added to README.md, with supporting Git infrastructure configuration. .gitattributes is updated to route .gif files through Git LFS, and .gitignore is configured to exclude local visualization scripts and rendered video outputs. The Gallery section itself contains two centered images showcasing cuNLS examples (sphere pose-graph refinement and Kepler orbit fitting) with descriptive bullet points, inserted between introductory content and the existing Features section.

Changes

Gallery Feature Infrastructure and Documentation

Layer / File(s)	Summary
Git configuration for media handling .gitattributes, .gitignore	Configure Git LFS to manage *.gif files and add .gitignore patterns for local visualization directories (viz/) and rendered video outputs (*.mp4).
Gallery section in README README.md	Insert a ## Gallery section with two centered example images (sphere pose-graph refinement and Kepler orbit fitting) and accompanying bullet descriptions, positioned between the intro and ## Features sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through docs so bright,
With Git LFS and GIFs in sight—
Two cuNLS examples, posed just right,
Spheres and orbits, pure delight,
🐇✨ The Gallery shines in the night!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add assets' directly relates to the main changes: adding asset files (GIFs), configuring Git LFS for assets, and updating documentation to showcase them.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch dev/ak/assets

---

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 26-45: The Gallery section in the README contains a broken
markdown link to the `viz/` directory which does not exist in the repository. In
the Gallery section, locate the line containing `[viz/](viz/)` and either create
the `viz/` directory with the referenced source code files for the
visualizations, or remove the link entirely and update the bullet points to
reference the source code location differently (or remove the reference if
source code is not available). Ensure that all links in the README point to
valid directories or resources so users can successfully access referenced
materials.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Enterprise

Run ID: eaf94664-4896-49a2-92ff-9e1cd59e4fd3

📥 Commits

Reviewing files that changed from the base of the PR and between 2a6b995 and f68d97a.

⛔ Files ignored due to path filters (2)

• assets/kepler_orbits.gif is excluded by !**/*.gif
• assets/sphere_refine.gif is excluded by !**/*.gif

📒 Files selected for processing (1)

• README.md