Skip to content

Fix badges on tutorials#3

Open
mlvandijk wants to merge 2 commits into
foojayio:mainfrom
mlvandijk:fix
Open

Fix badges on tutorials#3
mlvandijk wants to merge 2 commits into
foojayio:mainfrom
mlvandijk:fix

Conversation

@mlvandijk
Copy link
Copy Markdown
Contributor

@mlvandijk mlvandijk commented Apr 11, 2026

Summary by CodeRabbit

  • Documentation
    • Updated badge metadata for Java application tutorial cards to distinguish between Tutorial and Video content types.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 11, 2026

📝 Walkthrough

Walkthrough

Updated badge metadata in tutorial card sections within SPEC.md. The "Creating your first Java application with IntelliJ IDEA" section now includes both Tutorial and Video badges, while "Create your first Java application" section now uses Tutorial instead of Video.

Changes

Cohort / File(s) Summary
Documentation Metadata
SPEC.md
Updated tutorial card badge metadata for two Java application tutorial sections; one now includes both Tutorial and Video badges, the other replaces Video with Tutorial.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A hop, skip, and badge update today,
Tutorial tags now lead the way,
Video and words in harmony blend,
Documentation improvements never end! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Fix badges on tutorials' directly and accurately reflects the main change: updating badge metadata on tutorial documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@SPEC.md`:
- Around line 84-92: Edit index.html to update the badge elements for the two
Java tutorial cards: for the card titled "Creating your first Java application
with IntelliJ IDEA" add the badge-framework element/class alongside the existing
badge-assistant so it shows both Tutorial and Video badges, and for the card
titled "Create your first Java application" remove the badge-assistant
element/class and replace it with badge-framework so it shows only the Tutorial
badge; keep the badge markup consistent with other cards (same element/tag and
CSS classes).
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: e40b2515-fc03-4ff7-9958-5f75a57fe85e

📥 Commits

Reviewing files that changed from the base of the PR and between 647f6b4 and 590873e.

📒 Files selected for processing (1)
  • SPEC.md

Comment thread SPEC.md
Comment on lines +84 to 92
- **Badges:** Tutorial, Video
- **Description:** A video tutorial on how to create and run a simple Java application that prints Hello, World! to the system output.
- **Links:** [Video](https://www.youtube.com/watch?v=V_vXRRydnYI)

### Create your first Java application

- **Badges:** Video
- **Badges:** Tutorial
- **Description:** A written tutorial on how to create, build, run and package a simple Java application.
- **Links:** [Website](https://www.jetbrains.com/help/idea/creating-and-running-your-first-java-application.html)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify that index.html badges match the SPEC.md changes

echo "=== Checking 'Creating your first Java application with IntelliJ IDEA' ===" 
rg -A 5 -B 2 'Creating your first Java application with IntelliJ IDEA' index.html

echo ""
echo "=== Checking 'Create your first Java application' ==="
rg -A 5 -B 2 'Create your first Java application(?! with IntelliJ)' index.html

Repository: foojayio/java-education-catalog

Length of output: 1016


🏁 Script executed:

#!/bin/bash
# Check both cards mentioned in the review comment

echo "=== Checking 'Creating your first Java application with IntelliJ IDEA' ==="
rg -A 8 'Creating your first Java application with IntelliJ IDEA' index.html | head -20

echo ""
echo "=== Checking 'Create your first Java application' ==="
# Search for the card with the jetbrains.com link matching the second entry
rg -B 3 -A 8 'creating-and-running-your-first-java-application' index.html

echo ""
echo "=== Checking badge class usage in file ==="
rg 'badge-(framework|assistant|inference|resource)' index.html | head -30

Repository: foojayio/java-education-catalog

Length of output: 2971


Update index.html to match the badge specifications in SPEC.md.

The following cards in index.html have incorrect badges and do not match SPEC.md:

  1. "Creating your first Java application with IntelliJ IDEA" – Currently has only badge-assistant (Video); should have both badge-framework (Tutorial) and badge-assistant (Video)
  2. "Create your first Java application" – Currently has only badge-assistant (Video); should have only badge-framework (Tutorial)

Since index.html contains hardcoded HTML with no build process, these badge changes must be manually applied for the site to reflect the updated specification.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@SPEC.md` around lines 84 - 92, Edit index.html to update the badge elements
for the two Java tutorial cards: for the card titled "Creating your first Java
application with IntelliJ IDEA" add the badge-framework element/class alongside
the existing badge-assistant so it shows both Tutorial and Video badges, and for
the card titled "Create your first Java application" remove the badge-assistant
element/class and replace it with badge-framework so it shows only the Tutorial
badge; keep the badge markup consistent with other cards (same element/tag and
CSS classes).

@igfasouza
Copy link
Copy Markdown
Collaborator

At the moment, we don’t have an AI code assistant in place to automatically generate the index from the SPEC.md file. Because of this, changes to SPEC.md need to be manually reflected in the generated index as well.

Could you please update and include the corresponding index file in this PR? That will help us properly review and keep everything consistent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants