By contributing, you agree to abide by our Code of Conduct to ensure a welcoming and respectful community for all.
Ways to Contribute
Fix inaccuracies
Spot an outdated Webflow API method or incorrect example? Submit a fix.
Improve references
Make existing Webflow documentation clearer, more complete, or better structured.
Add references
Contribute new reference files for Webflow APIs or topics not yet covered.
Propose new skills
Have an idea for a new Webflow Agent Skill? Open an issue to discuss it.
Getting Started
Prerequisites
Before you begin, make sure you have:- Node.js 20 or higher
- Familiarity with Markdown and YAML frontmatter
- Understanding of Webflow’s ecosystem (Designer API, Data API, etc.)
- Git and GitHub account
Setup
Fork the repository
Navigate to the webflow-skills repository and click the “Fork” button in the top right.
Skill Structure
Each skill lives inskills/<skill-name>/ and is anchored by a SKILL.md file with YAML frontmatter:
SKILL.md should include:
- Quick start workflow
- Core patterns
- Reference index linking to all files in
references/
To scaffold a new skill, use:
Reference File Conventions
Every file inreferences/ must have YAML frontmatter with three required fields:
Content Guidelines
Reference files should:- ✅ Use fenced code blocks with language identifiers (e.g.,
```typescript) - ✅ Use Markdown tables for structured data
- ✅ Use blockquotes (
>) for callouts and notes - ✅ Include a Table of Contents with a horizontal rule separator after it
- ✅ End each reference with a Best Practices section where applicable
- ✅ Keep references focused on one API domain or topic per file
Converting from Webflow Docs
Webflow’s official documentation often uses JSX/HTML components. Convert these to plain Markdown:| Source component | Convert to |
|---|---|
<Tabs> / <Tab> | Separate sections with ### headings |
<Note> / <Warning> | Blockquote (>) |
<Steps> / <Step> | Numbered list with ### sub-headings |
<Accordion> | Standard Markdown table or section |
<Frame> / <img> | Remove (image URLs won’t resolve in this context) |
<Button> / <a> | Inline Markdown link |
Example conversion
Example conversion
Source (with JSX):The source documentation might use
<Note> components and <Tabs> with nested code blocks.Converted (plain Markdown):Use blockquotes for notes, section headings for tabs, and regular fenced code blocks:- Replace
<Note>with> **Note:** content - Replace
<Tabs>sections with###headings - Keep code blocks as standard fenced code blocks
- Remove nested Tab components
Development Workflow
Create a branch
Create a new branch for your changes:Use conventional commit prefixes:
feat/- New features or skillsfix/- Bug fixes or correctionsdocs/- Documentation improvementsrefactor/- Code restructuring
Make your changes
Follow the conventions outlined in this guide:
- Maintain proper frontmatter in all files
- Use plain Markdown (no JSX)
- Include code examples
- Add appropriate tags/keywords
Update reference index
If you added or removed reference files, update the corresponding
SKILL.md reference index to reflect the changes.Run sync script
If you changed This updates:
SKILL.md frontmatter, run the sync script:manifest.json- Plugin files (
.claude-plugin/,.cursor-plugin/) skills/index.jsonREADME.md
Pull Request Process
Before Submitting
Ensure your contribution meets these requirements:Frontmatter validation
Frontmatter validation
- ✅ All reference files have valid YAML frontmatter
- ✅ Frontmatter includes
name,description, andtags - ✅ SKILL.md includes all required metadata fields
Content validation
Content validation
- ✅ Code examples are accurate and use correct Webflow API methods
- ✅ No JSX/HTML components from Webflow docs remain
- ✅ Links to other files and resources are valid
- ✅ Tables and code blocks are properly formatted
Index synchronization
Index synchronization
- ✅
SKILL.mdreference index is up to date - ✅ Sync script has been run if frontmatter changed
- ✅ Generated files reflect your changes
PR Guidelines
When submitting your pull request:Write a clear title
Describe what changed concisely:Good examples:
- “Update variables-api.md to match latest Designer API”
- “Add authentication reference for Data API”
- “Fix typo in webflow-cms skill description”
- “Updates”
- “Fixed stuff”
- “Changes to docs”
Use common sense when drafting your pull request. The goal is to make it easy for maintainers to review and merge your changes. Include sufficient details but avoid unnecessary information.
What Happens Next
After submitting your PR:- Automated checks run - GitHub Actions validates your changes
- Maintainer review - A maintainer will review your PR
- Feedback - You may be asked to make changes
- Merge - Once approved, your PR will be merged
- Deployment - Changes are automatically deployed
Common Contribution Scenarios
Fixing an outdated API reference
Fixing an outdated API reference
Update version
Consider updating the skill version in
SKILL.md metadata if it’s a significant changeAdding a new reference file
Adding a new reference file
Creating a new skill
Creating a new skill
Need Help?
If you get stuck or have questions:GitHub Issues
For bug reports, inaccuracies, and feature requests
GitHub Discussions
For questions and community support
Development Best Practices
- ✅ Always use conventional commit prefixes (
feat:,fix:,docs:, etc.) - ✅ Create feature branches, never commit directly to
main - ✅ Run
sync-skills.jsafter changing frontmatter - ✅ Test your changes locally before pushing
- ✅ Write clear commit messages and PR descriptions
- ✅ Keep PRs focused on a single change or feature
Thank you for contributing to Webflow Agent Skills!