Skip to content

docs: Fix tasks.json example#164

Merged
subsy merged 1 commit intosubsy:mainfrom
ArnaudRinquin:patch-1
Jan 20, 2026
Merged

docs: Fix tasks.json example#164
subsy merged 1 commit intosubsy:mainfrom
ArnaudRinquin:patch-1

Conversation

@ArnaudRinquin
Copy link
Copy Markdown
Contributor

@ArnaudRinquin ArnaudRinquin commented Jan 20, 2026 •
edited by coderabbitai bot
Loading

2 issues:

  • top level "title" attribute should actually be "name"
  • "stories" → "userStories"

Summary by CodeRabbit

  • Documentation
    • Updated the JSON output format documentation for the convert CLI command, including:
      • Root-level field renamed from "title" to "name"
      • Array renamed from "stories" to "userStories"
      • Enhanced user story structure with additional fields for description, acceptance criteria, dependencies, and validation tracking

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

@ArnaudRinquin
Fix tasks.json example
3595d08 
2 issues: 

- top level "title" attribute should actually be "name"
- "stories" → "userStories"
@vercel
Copy link
Copy Markdown

vercel bot commented Jan 20, 2026

@ArnaudRinquin is attempting to deploy a commit to the plgeek Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 20, 2026 •
edited
Loading

Walkthrough

Documentation update to the CLI convert command showing an enhanced JSON output schema. The root field "title" is renamed to "name", the "stories" array becomes "userStories", and user story objects now include explicit fields for description, acceptance criteria, dependencies, and test results.

Changes

Cohort / File(s) Summary
CLI Documentation Updates
website/content/docs/cli/convert.mdx		 JSON example schema changes: root "title" → "name", "stories" → "userStories", and expanded user story structure with "acceptanceCriteria", "dependsOn", and "passes" fields

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The docs hop along with clearer names today,
From "stories" to "userStories"—hooray, hooray!
With "acceptanceCriteria" now in sight,
The schema dances in JSON light ✨

🚥 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 'docs: Fix tasks.json example' directly and concisely summarises the main change—correcting the tasks.json documentation example.
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.

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.

@ArnaudRinquin ArnaudRinquin changed the title [Docs] Fix tasks.json example docs: Fix tasks.json example Jan 20, 2026
@subsy
Copy link
Copy Markdown
Owner

subsy commented Jan 20, 2026

@ArnaudRinquin thanks - great catch

@vercel
Copy link
Copy Markdown

vercel bot commented Jan 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
ralph-tui Ready Ready Preview, Comment Jan 20, 2026 10:38am

Request Review

@subsy subsy merged commit 93408e2 into subsy:main Jan 20, 2026
9 checks passed
@ArnaudRinquin ArnaudRinquin deleted the patch-1 branch January 21, 2026 11:01
sakaman pushed a commit to sakaman/ralph-tui that referenced this pull request Feb 15, 2026
@subsy
Merge pull request subsy#164 from ArnaudRinquin/patch-1
62f6560
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ArnaudRinquin @subsy