Skip to content

Conversation

@divyanshub024
Copy link
Member

@divyanshub024 divyanshub024 commented Feb 9, 2026

Description

Add stac agent skills documentation

Related Issues

Closes #445

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Code refactor
  • Build configuration change
  • Documentation
  • Chore

Summary by CodeRabbit

  • Documentation
    • Added new skills documentation page with installation instructions and available skills overview.
    • Updated documentation navigation to include the skills section.

- Introduced new skills for scaffolding custom Stac widgets and actions, including templates and scripts for generating models and parsers.
- Added a quickstart skill to initialize and validate Stac-enabled Flutter projects, with detailed workflows and required inputs.
- Included necessary assets, references, and scripts to support the new functionalities.
- Introduced new Dart templates for scaffolding custom Stac actions and widgets, including action parsers and widget parsers.
- Each template includes JSON serialization support and basic structure for implementing action logic and widget rendering.
- Implemented a pre-check mechanism in `scaffold_custom_action.py` and `scaffold_custom_widget.py` to verify if output files already exist before writing, preventing partial file creation.
- Enhanced error handling to manage potential `FileExistsError` exceptions more gracefully.
- Adjusted the indentation for theme style examples in the style-recipes.md file to ensure proper formatting and readability.
- Modified the regex for screen name validation to ensure it starts with a lowercase letter and contains only lowercase letters, digits, and underscores. This improves input validation for screen names.
- Added comments to clarify the usage of `clearScreenCache` and `clearAllCache` methods in the cache-debug.md file, improving readability and understanding for users.
- Refactored the STAC screen annotation check to store the result of `has_annotation(stac_dir)` in a variable before using it, improving code readability and efficiency.
- Introduced a new documentation file for Stac Agent Skills, detailing AI-powered skills that assist in building, troubleshooting, and extending Stac applications.
- Updated the main documentation JSON to include a reference to the new skills section, enhancing the overall documentation structure.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 9, 2026

📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation for Stac Agent Skills by introducing a new documentation page and updating the navigation structure. A new docs/skills.mdx file details what skills are, lists available skills (stac-quickstart, stac-screen-builder, stac-custom-extensions, stac-troubleshooter), and provides installation and usage instructions.

Changes

Cohort / File(s) Summary
Documentation Structure
docs/docs.json
Added "skills" page entry to the Get Started group in the navigation structure.
Skills Documentation
docs/skills.mdx
New comprehensive documentation covering skill installation, definitions, available skills with usage scenarios, how to use skills with examples, and next steps for exploring and creating custom skills.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A rabbit hops through docs so bright,
New skills page shines with learning light,
From quickstart to troubleshooting cheer,
Agent Skills docs are crystal clear! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add skills documentation' directly and concisely summarizes the main change—adding documentation for Stac Agent Skills to the docs folder.
Linked Issues check ✅ Passed The PR successfully addresses issue #445 by adding comprehensive documentation for Stac Agent Skills, explaining what they are, how to use them, and available skills (stac-quickstart, stac-screen-builder, stac-custom-extensions, stac-troubleshooter).
Out of Scope Changes check ✅ Passed All changes are in-scope: docs.json navigation update and new skills.mdx documentation file both directly support the documentation objective for Agent Skills.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/add-skills-documentation

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
docs/skills.mdx (2)

6-16: Consider reordering: explain what Skills are before showing how to install them.

The "Installation" section (line 8) precedes "What are Skills?" (line 18). Readers unfamiliar with Skills will hit an install command before understanding what they're installing. Swapping these two sections would improve the reading flow.

Also, the npx skills add command assumes Node.js/npm is available—consider adding a brief prerequisite note or linking to Node.js installation docs.


92-97: "What's Next?" items lack actionable links.

"Browse the skills/ directory," "Check out reference guides," and "Create your own skills" don't link anywhere. Adding links (e.g., to the GitHub skills/ folder or relevant docs pages) would make these next steps actionable rather than vague.

Suggested improvement
 ## What's Next?
 
-- Browse the `skills/` directory to see what's available
-- Check out reference guides for specific patterns
-- Use skills when starting new features or projects
-- Create your own skills for team-specific workflows
+- Browse the [`skills/` directory](https://github.com/StacDev/stac/tree/dev/skills) to see what's available
+- Check out reference guides for specific patterns
+- Use skills when starting new features or projects
+- [Create your own skills](/concepts/custom_skills) for team-specific workflows

Adjust URLs to match the actual paths in the repo/docs.


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.

@divyanshub024 divyanshub024 merged commit c8031b2 into dev Feb 9, 2026
3 checks passed
@divyanshub024 divyanshub024 deleted the docs/add-skills-documentation branch February 9, 2026 12:25
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.

docs: Add documentation for Stac Agent Skills

1 participant