Add link to puzzletron_v2

[Separius]

Summary by CodeRabbit

• Documentation
  • Added a top-level Puzzletron overview with a link to the step-by-step algorithm tutorial.
  • Added a reference to the experimental Puzzletron branch for advanced, production-scale usage.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: c9ffd936-d4ea-44bf-8dcb-58a96fd27e54

📥 Commits

Reviewing files that changed from the base of the PR and between 4a435eb and 7565d68.

📒 Files selected for processing (1)

• examples/puzzletron/README.md

🚧 Files skipped from review as they are similar to previous changes (1)

• examples/puzzletron/README.md

---

📝 Walkthrough

Walkthrough

The Puzzletron README now introduces the project, links to a step-by-step algorithm tutorial, and references an experimental branch for advanced usage.

Changes

Puzzletron documentation

Layer / File(s)	Summary
README introduction examples/puzzletron/README.md	Adds a Puzzletron overview, tutorial link, and experimental branch reference for advanced usage.

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

Suggested reviewers: kevalmorabia97

🚥 Pre-merge checks | ✅ 6

✅ Passed checks (6 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title matches the main change: adding a Puzzletron link/reference in the README, including the experimental branch pointer.
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.
Security Anti-Patterns	✅ Passed	Only examples/puzzletron/README.md changed; no Python or dependency files were modified, so none of the listed security anti-patterns are present.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch Separius-patch-1

---

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

[coderabbitai]

Warning

CodeRabbit couldn't request changes on this pull request because it doesn't have sufficient GitHub permissions.

Please grant CodeRabbit Pull requests: Read and write permission and re-run the review.

👉 Steps to fix this

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 `@examples/puzzletron/README.md`:
- Line 3: Update the introductory sentence in the README to make “Puzzletron
Algorithm Tutorial” an internal Markdown anchor link targeting that tutorial
section, replacing the non-link “see below” wording while preserving the
surrounding guidance.

🪄 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.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 3c6eeec1-c9e6-4399-950d-04804d90cca9

📥 Commits

Reviewing files that changed from the base of the PR and between 5d0e9b2 and 8330af3.

📒 Files selected for processing (1)

• examples/puzzletron/README.md

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.79%. Comparing base (9392dfe) to head (7565d68).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1996      +/-   ##
==========================================
- Coverage   77.79%   77.79%   -0.01%     
==========================================
  Files         518      518              
  Lines       58204    58204              
==========================================
- Hits        45279    45277       -2     
- Misses      12925    12927       +2     

Flag	Coverage Δ
examples	33.27% <ø> (-0.27%)	⬇️
unit	54.80% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 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.

[danielkorzekwa]

some tiny comments only, approved