LogoClawIndex
CasesSkillsAbout
LogoClawIndex

readme-standards - README structure and compliance rules

Defines required README sections, code example standards, credential safety, testing guidance, formatting, and validation checks.

Tags

Updated: 2026-09-30
READMEdocumentationMarkdownTypeScripttestingcredentialsvalidation

Capabilities

Validate required sectionsReview TypeScript examplesCheck credential safetyVerify testing guidance

Typical Inputs

README contentUSERGUIDE.md contentModule documentation

Typical Outputs

Compliance findingsPass or fail results

What this skill does

  • Validate required sections
  • Review TypeScript examples
  • Check credential safety
  • Verify testing guidance
  • Check Markdown formatting

Inputs

  • README content
  • USERGUIDE.md content
  • Module documentation

Outputs

  • Compliance findings
  • Pass or fail results

Requirements

    Source

    • Spec: SKILL.md

    ClawIndex

    OpenClaw Skills & Use Case Index

    ClawIndex is an ecosystem-driven index of OpenClaw skills and real-world use cases.

    Index

    Skills·
    Cases

    Meta

    About·
    Disclaimer·
    Email·
    GitHub
    © 2026 ClawIndex All Rights Reserved.