wiki

Name: wiki
Author: mike-at-redspace

Documentation wiki files in Markdown format - git submodule for GitHub wiki

by mike-at-redspace(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from mike-at-redspace/video-ambient-glow (.cursor/rules/wiki.mdc). Copyright stays with the author.

Use Markdown format for all documentation
Include code examples with syntax highlighting
Reference framework integrations: React, Vue, Svelte, Angular
API documentation should match types in src/types.ts
Include installation instructions, usage examples, configuration options
Use clear headings and structure
Link between pages where relevant
Examples should be copy-paste ready and tested
Include performance tips and best practices
Document all public API methods and options
Note: wiki/ is a git submodule pointing to the GitHub wiki repository
After editing wiki files, publish with npm run wiki (runs scripts/publish-wiki.sh)
Remember to commit the submodule update in main repo: git add wiki && git commit -m "Update wiki submodule"
@file wiki/API-Reference.md
@file wiki/Examples.md
@file scripts/publish-wiki.sh

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/mike-at-redspace-video-ambient-glow-wiki-rule/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

mike-at-redspace-video-ambient-glow-wiki-rule.ocm.jsonjson

{
  "ocm": "1",
  "id": "mike-at-redspace-video-ambient-glow-wiki-rule",
  "kind": "skill",
  "name": "wiki",
  "description": "Documentation wiki files in Markdown format - git submodule for GitHub wiki",
  "publisher": "mike-at-redspace",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "github-cursor-rules"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Documentation wiki files in Markdown format - git submodule for GitHub wiki"
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-cursor-rules",
      "repository": "https://github.com/mike-at-redspace/video-ambient-glow",
      "path": ".cursor/rules/wiki.mdc",
      "ref": "a67964062e59ebd79397078d3ec7e3c79b1dbcdd",
      "url": "https://github.com/mike-at-redspace/video-ambient-glow/blob/a67964062e59ebd79397078d3ec7e3c79b1dbcdd/.cursor/rules/wiki.mdc",
      "key": "mike-at-redspace/video-ambient-glow/.cursor/rules/wiki.mdc"
    },
    "applies_to": [
      "wiki/**"
    ]
  },
  "instructions": "- Use Markdown format for all documentation\n- Include code examples with syntax highlighting\n- Reference framework integrations: React, Vue, Svelte, Angular\n- API documentation should match types in `src/types.ts`\n- Include installation instructions, usage examples, configuration options\n- Use clear headings and structure\n- Link between pages where relevant\n- Examples should be copy-paste ready and tested\n- Include performance tips and best practices\n- Document all public API methods and options\n- **Note**: `wiki/` is a git submodule pointing to the GitHub wiki repository\n- After editing wiki ",
  "cost": {
    "context_tokens": 216
  }
}

Fetch it by URL: GET /api/v1/registry/mike-at-redspace-video-ambient-glow-wiki-rule/manifest?version=1.0.0

About

Use it

Manifest

Reviews