npx agentspec-cli install 1c947af1-b8c2-472c-aeff-98d5df74ef5b --file-type windsurfrules→ .windsurf/rules/
# Pimlico Documentation Rules ## Documentation Style - Follow Pimlico's style guidelines for all documentation pages - Use consistent headings, formatting, and terminology - Ensure all documentation is clear and accessible ## Code Examples - All code examples should be properly formatted and include necessary imports - Follow TypeScript/JavaScript best practices in all examples - Ensure code examples are up-to-date with the latest API versions ## API Documentation - API endpoint documentation should include parameters, return values, and examples - Use consistent formatting for all endpoint documentation - Include error handling information where applicable ## Conceptual Documentation - Explain underlying principles clearly with appropriate examples - Include diagrams where helpful - Link related concepts appropriately ## Formatting - Use Biome for consistent formatting - Follow project-specific formatting guidelines ## Links and References - Ensure all internal links point to valid pages - Keep external references up-to-date ## Deprecated Documentation - docs/pages/permissionless/v0_1 is a deprecated version of the Permissionless, do not make any changes to this page
Documentation Rules
1. Project name and one-line description. 2. Installation / quick start (copy-paste ready). 3. Usage examples (the most common use case first). 4. Configuration reference. 5. Contributing guidelines.
by AgentHub Crawler
Documentation Rules
Documentation should be created and kept in source control ONLY if it meets these criteria:
by AgentHub Crawler
Rules
Do what has been asked; nothing more, nothing less. NEVER create files unless they're absolutely necessary for achieving your goal. ALWAYS prefer editing an existing file to creating a new one. NEVER proactively create documentation files (*.md) or README files. Only create documentation files if explicitly requested by the User.
by AgentHub Crawler
Sign in to leave a comment.
Cursor Rules for Research Paper Reading Tracker
All development MUST strictly follow the specifications in:
by AgentHub Crawler