Skip to content

docs: add creator onboarding tutorial - #16

Merged
vatsal-vb merged 1 commit into
Jaabaali:mainfrom
pedro-passariol:codex/creator-onboarding
Nov 21, 2026
Merged

vatsal-vb merged 1 commit into
Jaabaali:mainfrom
pedro-passariol:codex/creator-onboarding

Conversation

@pedro-passariol

Copy link
Copy Markdown
Contributor

What does this change?

Adds “Building Games with Jabali Studio,” a creator onboarding tutorial covering first playable builds, AI settings, incremental development, visual references, checkpoints, thread resets, development tools, and external workflows. Preserves the supplied eight-section tutorial and examples, includes the creator onboarding video, and links to existing reference guides.

Adds the page to the Learn by building sidebar, tutorial index, and beginner path. Adjusts the tutorial index introduction so its screenshot and timestamp description applies to project tutorials.

Validation

  • npm run build passed: 51 pages built and all internal links valid.
  • git diff --cached --check passed before committing.
  • Compared the page with the supplied text: all tutorial paragraphs preserved.
  • Inspected generated HTML headings and prompt blocks; confirmed the supplied video embed is present.

Checklist

  • Every new or changed page has a title and a description (50–160 characters)
  • Images have alt text that describes the screenshot (no images added)
  • Internal links start with /docs/ and end with / (section links include anchors)
  • It documents features that are already released (existing Studio workflows)
  • I previewed the change (read generated HTML)

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Add creator onboarding tutorial and learning-path links

📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Adds a creator onboarding tutorial covering playable builds, AI settings, iteration, checkpoints,
 and external tools.
• Includes example prompts, an onboarding video, and links to related Studio guides.
• Links the tutorial from the sidebar, tutorial index, and beginner path.
Diagram

graph TD
  Sidebar["Learn by building"] --> Tutorial["Onboarding tutorial"] --> Guides["Studio guides"]
  Index["Tutorial index"] --> Tutorial --> Video["Onboarding video"]
  Beginner["Beginner path"] --> Tutorial
Loading
High-Level Assessment

A standalone Starlight tutorial linked from existing learning entry points fits the site's structure. Folding this general workflow into the project-specific tutorials would make it harder to find and repeat the guidance.

Files changed (4) +145 / -1

Documentation (3) +144 / -1
beginner.mdOffer creator onboarding after the beginner path +1/-0

Offer creator onboarding after the beginner path

• Adds the tutorial to the next-step links for readers ready to apply the workflow to their own game.

src/content/docs/start/beginner.md

creator-onboarding.mdDocument the creator onboarding workflow +138/-0

Document the creator onboarding workflow

• Adds an eight-section guide on starting with a playable mechanic, configuring Bali, iterating and playtesting, using references, preserving builds, resetting threads, and incorporating other tools. Includes example prompts, an embedded video, and links to related guides.

src/content/docs/tutorials/creator-onboarding.md

index.mdIntroduce onboarding on the tutorial index +5/-1

Introduce onboarding on the tutorial index

• Adds a link and summary for the new guide. Narrows the screenshot and timestamp introduction to project tutorials, so it does not imply the onboarding guide follows that format.

src/content/docs/tutorials/index.md

Other (1) +1 / -0
astro.config.mjsList creator onboarding in the Learn by building sidebar +1/-0

List creator onboarding in the Learn by building sidebar

• Adds the new tutorial directly after the tutorial index, making it visible alongside existing project tutorials.

astro.config.mjs

@qodo-code-review

qodo-code-review Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 🔗 Cross-repo conflicts (0) 📜 Skill insights (0)

Grey Divider


Informational

1. Tutorial claims undocumented GDD and README files 🐞 Bug ≡ Correctness
Description
The paragraph in the Reset Threads section states that Studio keeps a GDD and README alongside
project files for the agent to recover context from, but the sentence is not backed by any other
page in the docs. A reader who follows it will look for these files and find no documented behavior
to explain them, and the claim is the only basis for the advice to reset threads freely.
Code

src/content/docs/tutorials/creator-onboarding.md[96]

+Studio maintains project documentation such as the GDD and README alongside your project files, which the agent can use to recover context. Don't be afraid to reset the conversation and start fresh.
Evidence
A repository-wide search of src/content/docs for 'README' returns only this new page, and 'GDD'
returns no matches under src/content/docs/studio. The reset-thread guidance depends on this
context-recovery behavior, which the tutorial asserts without a reference. The Studio reference
pages (for example debugging.md 'Reset the chat when Bali gets stuck') describe Reset Thread without
mentioning project documentation files.

src/content/docs/tutorials/creator-onboarding.md[96-96]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The creator onboarding tutorial says Studio maintains a GDD and README alongside project files that the agent uses to recover context. No other docs page describes this, so readers cannot verify it.

## Fix Focus Areas
- src/content/docs/tutorials/creator-onboarding.md[96-98]
- src/content/docs/studio/debugging.md[66-84]

## Recommended Fix
Confirm with the Studio team that project GDD and README files are generated and read by the agent. If they are, add a short description with a link to the reference page that covers them. If not, reword the sentence to describe only what Reset Thread does, which per debugging.md clears the conversation without changing the project.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Dismiss ↗ | View ↗


Grey Divider

Context sources
✅ Cross-repo context — repo relationships
Review mode: Auto: 🚀 Fast: Localized documentation and navigation changes with no runtime behavior.

Grey Divider

Tip of the day
💡 Did you know, you can add REVIEW.md to your repo root and Qodo follows it on every PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo


Long conversations can slow the agent down and decrease the quality of its outputs.

Studio maintains project documentation such as the GDD and README alongside your project files, which the agent can use to recover context. Don't be afraid to reset the conversation and start fresh.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Informational

1. Tutorial claims undocumented gdd and readme files 🐞 Bug ≡ Correctness

The paragraph in the Reset Threads section states that Studio keeps a GDD and README alongside
project files for the agent to recover context from, but the sentence is not backed by any other
page in the docs. A reader who follows it will look for these files and find no documented behavior
to explain them, and the claim is the only basis for the advice to reset threads freely.
Agent Prompt
## Issue description
The creator onboarding tutorial says Studio maintains a GDD and README alongside project files that the agent uses to recover context. No other docs page describes this, so readers cannot verify it.

## Fix Focus Areas
- src/content/docs/tutorials/creator-onboarding.md[96-98]
- src/content/docs/studio/debugging.md[66-84]

## Recommended Fix
Confirm with the Studio team that project GDD and README files are generated and read by the agent. If they are, add a short description with a link to the reference page that covers them. If not, reword the sentence to describe only what Reset Thread does, which per debugging.md clears the conversation without changing the project.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Dismiss ↗ | View ↗

@vatsal-vb
vatsal-vb merged commit 037735c into Jaabaali:main Nov 21, 2026
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