Skip to content

docs: document playground example maintenance workflow - #125

Merged
TharmiganK merged 1 commit into
ballerina-nutcracker:mainfrom
snelusha:docs/example-gen-guide
Aug 12, 2026
Merged

TharmiganK merged 1 commit into
ballerina-nutcracker:mainfrom
snelusha:docs/example-gen-guide

Conversation

@snelusha

@snelusha snelusha commented Aug 11, 2026 •

Copy link
Copy Markdown
Contributor

Purpose

$subject

Summary by CodeRabbit

  • Documentation
    • Added guidance for maintaining Playground examples, including regenerating generated assets and updating default configurations.
    • Documented when to refresh and review visual fixtures and service-example test data after intentional changes.

@coderabbitai

coderabbitai Bot commented Aug 11, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 4ce29381-e48c-446f-b22e-08e2ca35b3c5

📥 Commits

Reviewing files that changed from the base of the PR and between c201980 and 9d7b6d4.

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

📝 Walkthrough

Walkthrough

The change adds AGENTS.md guidance for updating generated Playground examples, default example configuration, Playwright golden fixtures, and service-example request/response data.

Changes

Playground example maintenance

Layer / File(s) Summary
Example maintenance instructions
AGENTS.md
Adds guidance to regenerate generated examples, update default example configuration, and refresh related Playwright and service-example test data after intentional changes.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description contains only an incomplete Purpose section and omits the required goals, approach, testing, security, documentation, and release information. Complete the required template sections and replace "$subject" with a specific purpose statement, including testing, documentation, and release details.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation added for the Playground example maintenance workflow.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ 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.

@snelusha
snelusha force-pushed the docs/example-gen-guide branch from 3ca0556 to 9d7b6d4 Compare August 11, 2026 21:31
@snelusha

Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Aug 11, 2026 •

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@TharmiganK
TharmiganK merged commit 4de925e into ballerina-nutcracker:main Aug 12, 2026
2 checks passed
@snelusha
snelusha deleted the docs/example-gen-guide branch August 12, 2026 06:18
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