docs: update documentation references

[ranjeet150]

docs: update documentation references

Closes #131

Summary by CodeRabbit

• Documentation
  • Updated the README with a documentation reference. This change is limited to written project information and does not alter app features or behavior. No changes to user-facing functionality are included in this update.

[vercel]

@ranjeet150 is attempting to deploy a commit to the Josh's projects Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 609ad7f8-49f2-4e07-a10d-9b912ef1841a

📥 Commits

Reviewing files that changed from the base of the PR and between 1ca52ee and c80ee88.

📒 Files selected for processing (1)

• README.md

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

---

📝 Walkthrough

Walkthrough

The README adds an HTML comment after the license reference.

Changes

README update

Layer / File(s)	Summary
Add README comment README.md	An HTML comment is added after the license reference.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: bosun-josh121

Merge Risk: ⚪ Minimal · up to c80ee

The README’s visible privacy statements are already consistent. The added comment does not create a merge-blocking risk.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	⚠️ Warning	The PR summary identifies only an HTML comment, Updated documentation reference, added after the license reference. The comment does not clarify the current private-policy behavior or the roadmap di…	Remove the unrelated HTML comment, or replace it with a documentation change that directly supports issue [#131].

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the README documentation reference update. It is concise and specific enough for the changeset.
Linked Issues check	✅ Passed	Issue [#131] requires consistent documentation. The reviewed README already separates current v1 privacy from the roadmap: it states that the policy and policy-to-release link are private today, ident…
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…

Full details: Out of Scope Changes check

Explanation

The PR summary identifies only an HTML comment, Updated documentation reference, added after the license reference. The comment does not clarify the current private-policy behavior or the roadmap distinction in issue [#131]. It has no demonstrated connection to the linked issue.

• Fix all pre-merge checks with AI

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Create a new PR

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.

Warning

⚠️ This pull request has been flagged as potential spam (contributor-gaming) by CodeRabbit slop detection and should be reviewed carefully.

---

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