feat(skills): restructure docs + add PR lifecycle skills#16
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the Chalk system's ability to understand and automate development workflows. By centralizing comprehensive project metadata in an expanded Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This is a great pull request that significantly improves the structure of the chalk documentation and adds a suite of powerful new skills for the PR lifecycle. The move to a centralized chalk.json as a single source of truth is a solid architectural decision that will make skills more robust and easier to develop. The new PROFILE.md structure and the detailed content generation in setup-chalk and setup-docs are excellent enhancements. The new skills for working with issues, committing, capturing visuals, and creating PRs form a cohesive and very useful workflow. I have one minor suggestion regarding the workflow in capture-pr-visuals to make it more robust. Overall, this is a very impressive and well-executed set of changes.
…apture step Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
638121d to
84e7069
Compare
Restructure .chalk/docs from numbered files to PROFILE.md convention, expand chalk.json into a machine-readable project identity that skills consume, and add 5 new lifecycle skills completing the issue-to-PR workflow. Foundation: - chalk.schema.json defining the expanded chalk.json contract - setup-chalk v2.0.0 generates expanded chalk.json + PROFILE.md structure - setup-docs v2.0.0 enriches chalk.json and populates PROFILE stubs - validate-chalk audits completeness and reports gaps Lifecycle skills: - work-issue: GitHub issue → branch → context setup - commit: staging + conventional commit workflow - capture-pr-visuals: Playwright screenshot + GIF capture - create-pr: PR creation with visual preview integration
84e7069 to
5e83574
Compare
Summary
.chalk/docs/from numbered files (0_PRODUCT_PROFILE.md) toPROFILE.mdconvention — one canonical entry point per verticalchalk.jsonfrom 4 fields to a full machine-readable project identity (dev server, routes, source layout, test/build commands) with JSON Schemawork-issue,commit,capture-pr-visuals,create-pr,validate-chalkChanges
Foundation (docs restructure)
docs/chalk.schema.json— JSON Schema defining the expandedchalk.jsoncontract withproject,dev,test,build,routes, andsourceLayoutsectionssetup-chalkv2.0.0 — Generates expandedchalk.json+ newPROFILE.mdstructure. Includes framework detection table, route scanning, source layout mapping, and v1→v2 migration guidesetup-docsv2.0.0 — Enricheschalk.jsonwith fields setup-chalk couldn't detect (routes, source layout) and populates PROFILE stubs with deep codebase analysisvalidate-chalk— Auditschalk.jsonschema compliance and docs completeness. Reports gaps with actionable fix suggestions. Optionalfixmode auto-repairs issuesLifecycle skills
work-issue— Fetches GitHub issue → creates conventionally-named branch → readschalk.jsonfor project context → sets up implementation todo listcommit— Analyzes diffs → stages specific files → creates conventional commit messages. Supports granular commits for unrelated changescapture-pr-visuals— Readschalk.jsonfor dev server URL and routes → launches Playwright via npx → captures screenshots + GIF recordings → commits to.github/pr-screenshots/. Falls back to auto-discovery if no chalk docs existcreate-pr— Full PR workflow withgh pr create. Auto-embeds screenshots from.github/pr-screenshots/in a Visual Preview section. Useschalk.jsontest/dev commands for test planWhy this matters
Skills like
capture-pr-visualsneed to answer "what's the dev URL? what routes exist? what framework is this?" — previously that info was scattered across 4+ markdown files with no predictable location. Nowchalk.jsonis the single source of truth that any skill reads first.Test plan
scripts/validate-skills.shpasses (17 skills validated)/setup-chalkon a fresh repo and verify expandedchalk.json+ PROFILE.md structure/validate-chalkon a project with existing.chalk/to check gap reporting/capture-pr-visualson a running web app to verify Playwright capture flow/work-issue 42to verify branch creation and context setup/committo verify staging and conventional commit workflow/create-prto verify visual preview section embedding