chore: update readme

[bodinsamuel]

Pull Request

Description

Please include a summary of the change and which issue is fixed. Also include relevant motivation and context.

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

Summary by CodeRabbit

• Documentation
  • Updated the Table of Contents to link “Getting Started” to the official external guide and reorganized entries (Contributing, Security, FAQ, Support, License).
  • Removed the outdated “Development” anchor to simplify navigation.
  • Clarifies onboarding and directs users to the most current setup resources; no functional changes.

[graphite-app]

How to use the Graphite Merge Queue

Add the label Main to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

[CLAassistant]

All committers have signed the CLA.

[vercel]

@bodinsamuel is attempting to deploy a commit to the Databuddy Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

README Table of Contents updated: internal "Getting Started" and "Development" anchors replaced by a single external "Getting Started" link to https://www.databuddy.cc/docs/getting-started. No code or control-flow changes.

Changes

Cohort / File(s)	Summary
Docs: README ToC link update README.md	Replaced internal anchors for "Getting Started" and "Development" with one external "Getting Started" link to https://www.databuddy.cc/docs/getting-started; reordered/added ToC items (Contributing, Security, FAQ, Support, License).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• changes for the readme and contributing md files #159 — Modifies README "Getting Started" content/links and related navigation.

Poem

I nibble words and nudge a link,
A tiny hop — no code to sync.
The table’s tidy, paths align,
I stamp my paw, the docs look fine.
A carrot cheer for guides made bright. 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The pull request title correctly indicates that the README was updated, but it is overly generic and does not convey the specific nature of the change to the table of contents and external guide links. A more descriptive title would help teammates scanning the history immediately understand that anchors and formatting in the README’s navigation were modified.	Please revise the title to clearly describe the main change—for example, “chore: update README table of contents and external Getting Started link”—so that the scope of the update is immediately clear to reviewers and future maintainers.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 592bb73 and 9cb76c1.

📒 Files selected for processing (1)

• README.md (1 hunks)

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

• README.md

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f148c13 and 592bb73.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Vercel Agent Review

[bodinsamuel]

more bots maybe?