Add project badges to README

[the78mole]

Added badges for build status, release, downloads, and DeepWiki (for auto-update).

For DeepWiki to update automatically, you just need to add the badge to the README.

Summary by CodeRabbit

• Documentation
  • Project title updated to a new name.
  • Added four status badges (build/push image, release, downloads, docs).
  • Inserted a top-level TODO beneath the title.
  • Replaced the existing Description content with a TODO placeholder requesting an in-depth overview.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

README title changed from "jumpstarter-router" to "jumpstarter-controller"; four badges were added below the title; a top-level TODO was inserted under the title and the Description section was replaced with a TODO placeholder requesting an in-depth overview.

Changes

Cohort / File(s)	Summary
README documentation updates README.md	Renamed project title to jumpstarter-controller; added four status badges immediately after the title (build/push container image, GitHub Release, GitHub Downloads, Ask DeepWiki); inserted a top-level TODO under the title and replaced the Description content with a TODO placeholder.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Check badge image/target URLs and markdown syntax
• Ensure TODO placeholders follow project documentation conventions and formatting

Poem

🐰 I hopped in to tweak the header line,
Four badges stitched like stars to shine,
A TODO carrot left on top,
For future docs I'll never stop,
Small changes, big-hearted sign! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title accurately reflects the main change: adding project badges to the README file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• 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 ca4f06e and 0d84b83.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (7)

📓 Common learnings

Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter-controller PR: 137
File: deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/router-deployment.yaml:23-26
Timestamp: 2025-05-13T19:56:27.924Z
Learning: In the jumpstarter-controller project, the router service uses the same ConfigMap as the controller service (controller-cm.yaml) even though it has been moved to its own separate deployment.

📚 Learning: 2025-05-13T19:56:27.924Z

Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter-controller PR: 137
File: deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/router-deployment.yaml:23-26
Timestamp: 2025-05-13T19:56:27.924Z
Learning: In the jumpstarter-controller project, the router service uses the same ConfigMap as the controller service (controller-cm.yaml) even though it has been moved to its own separate deployment.

Applied to files:

• README.md

📚 Learning: 2025-10-24T11:57:23.796Z

Learnt from: mangelajo
Repo: jumpstarter-dev/jumpstarter-controller PR: 170
File: deploy/operator/internal/controller/jumpstarter/jumpstarter_controller.go:328-333
Timestamp: 2025-10-24T11:57:23.796Z
Learning: In the jumpstarter-controller operator (deploy/operator/), the design allows only one Jumpstarter CR per namespace, which will be enforced by a validation webhook. This constraint eliminates concerns about resource name collisions within a namespace.

Applied to files:

• README.md

📚 Learning: 2025-05-13T19:57:56.811Z

Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter-controller PR: 137
File: hack/deploy_with_helm.sh:26-34
Timestamp: 2025-05-13T19:57:56.811Z
Learning: The jumpstarter-dev repository uses a custom kind cluster configuration that allows NodePort services to use non-standard ports 5080 and 5443, outside the default Kubernetes NodePort range (30000-32767).

Applied to files:

• README.md

📚 Learning: 2025-02-17T20:31:08.553Z

Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter-controller PR: 101
File: internal/controller/client_controller_test.go:152-152
Timestamp: 2025-02-17T20:31:08.553Z
Learning: In the jumpstarter-controller repository, the `TokenKey` constant is defined within the `internal/controller` package and is accessible to all files within the same package.

Applied to files:

• README.md

📚 Learning: 2025-05-13T19:57:56.811Z

Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter-controller PR: 137
File: hack/deploy_with_helm.sh:26-34
Timestamp: 2025-05-13T19:57:56.811Z
Learning: The jumpstarter project uses a custom kind cluster configuration with an expanded NodePort range (3000-32767) and explicit port mappings for ingress (5080/5443) and gRPC services (30010/30011 mapped to 8082/8083).

Applied to files:

• README.md

📚 Learning: 2025-11-14T15:47:36.325Z

Learnt from: mangelajo
Repo: jumpstarter-dev/jumpstarter-controller PR: 190
File: api/v1alpha1/exporter_helpers.go:16-24
Timestamp: 2025-11-14T15:47:36.325Z
Learning: In the jumpstarter-controller project, migration annotations (jumpstarter.dev/migrated-namespace and jumpstarter.dev/migrated-uid) that override namespace and UID values in authentication tokens are acceptable without additional validation webhooks because the security model assumes only administrators have write access to Exporter and Client resources via K8s RBAC.

Applied to files:

• README.md

🔇 Additional comments (2)

README.md (2)

1-6: ✓ Title correction and badges properly implemented.

The title now correctly references "jumpstarter-controller" (resolving prior feedback), and all four badges are properly formatted with valid Markdown syntax and correct repository links.

---

40-40: No changes needed—router is an intentional separate deployment.

The README.md references to "jumpstarter-router" are correct. While the repository is named "jumpstarter-controller," the router is maintained as a separate deployable component with its own Helm deployment (as confirmed in the project architecture). Having distinct image names for the router and controller reflects their separation, not an inconsistency to be corrected.

Likely an incorrect or invalid review comment.

---

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: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 77ffdb7 and ca4f06e.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (4)

📚 Learning: 2025-05-13T19:56:27.924Z

Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter-controller PR: 137
File: deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/router-deployment.yaml:23-26
Timestamp: 2025-05-13T19:56:27.924Z
Learning: In the jumpstarter-controller project, the router service uses the same ConfigMap as the controller service (controller-cm.yaml) even though it has been moved to its own separate deployment.

Applied to files:

• README.md

📚 Learning: 2025-10-24T11:57:23.796Z

Learnt from: mangelajo
Repo: jumpstarter-dev/jumpstarter-controller PR: 170
File: deploy/operator/internal/controller/jumpstarter/jumpstarter_controller.go:328-333
Timestamp: 2025-10-24T11:57:23.796Z
Learning: In the jumpstarter-controller operator (deploy/operator/), the design allows only one Jumpstarter CR per namespace, which will be enforced by a validation webhook. This constraint eliminates concerns about resource name collisions within a namespace.

Applied to files:

• README.md

📚 Learning: 2025-05-13T19:57:56.811Z

Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter-controller PR: 137
File: hack/deploy_with_helm.sh:26-34
Timestamp: 2025-05-13T19:57:56.811Z
Learning: The jumpstarter-dev repository uses a custom kind cluster configuration that allows NodePort services to use non-standard ports 5080 and 5443, outside the default Kubernetes NodePort range (30000-32767).

Applied to files:

• README.md

📚 Learning: 2025-05-13T19:57:56.811Z

Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter-controller PR: 137
File: hack/deploy_with_helm.sh:26-34
Timestamp: 2025-05-13T19:57:56.811Z
Learning: The jumpstarter project uses a custom kind cluster configuration with an expanded NodePort range (3000-32767) and explicit port mappings for ingress (5080/5443) and gRPC services (30010/30011 mapped to 8082/8083).

Applied to files:

• README.md

🔇 Additional comments (1)

README.md (1)

3-6: Badge URLs are correctly formatted but build.yaml workflow existence cannot be confirmed.

The GitHub Release, Downloads, and DeepWiki badge URLs all follow correct shields.io endpoint formats and reference the jumpstarter-dev/jumpstarter-controller repository consistently. However, direct verification of whether the build.yaml workflow file actually exists in .github/workflows/ could not be completed due to repository access limitations. The build badge URL structure is syntactically valid, but confirmation requires inspection of the actual workflow files in the repository.

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Replace C-style TODO comments with proper markdown syntax or remove before merge.

The README contains C-style comments (// TODO(user):) which are not valid markdown syntax and will render as plain text to users. Since this is a public-facing README, these should either be:

• Converted to HTML comments: <!-- TODO(user): ... -->
• Or removed entirely after content is added

This gives the impression the README is incomplete or uses a template that hasn't been properly customized.

Consider one of the following approaches:

Option 1: Convert to HTML comments (if these are meant as internal notes for contributors)

-// TODO(user): Add simple overview of use/purpose
+<!-- TODO(user): Add simple overview of use/purpose -->

Option 2: Remove the TODO comments (recommended for a public README)

-// TODO(user): Add simple overview of use/purpose

 ## Description
-// TODO(user): An in-depth paragraph about your project and overview of use

Or fill in the actual content instead of leaving TODO placeholders.

Also applies to: 11-11, 98-98

🤖 Prompt for AI Agents

In README.md around lines 8, 11 and 98, there are C-style TODO comments (//
TODO(...)) which are not valid Markdown; replace each with either an HTML
comment (<!-- TODO(...) -->) if you want to keep internal notes, remove them
entirely, or replace them with actual README content; ensure no C-style comment
tokens remain and that any retained notes use proper Markdown/HTML comment
syntax or are converted into real documentation text.