Skip to content
Doug Fennell edited this page Oct 1, 2025 · 4 revisions

WARP (RDCP-Specific Development Rules)

This page mirrors the repository’s WARP.md and provides development rules specific to the RDCP SDK.

Key highlights:

  • Strict TypeScript usage across SDK source (no any types)
  • Protocol compliance: implement exact RDCP v1.0 endpoint and response formats
  • Auth levels: basic, standard (JWT), enterprise (mTLS + optional token)
  • File length constraints per file type
  • Testing patterns and coverage expectations
  • Minimal viable fixes and anti-overengineering guidance

For the complete content, see the canonical source above.

See also: Core-Package-Boundaries β€” enforce architectural boundaries while following WARP rules.

GitHub Wiki Links

Critical: GitHub Wiki [[...]] syntax does NOT support subdirectory paths.

Correct format:

[[Page-Name|Display Text]]
[[RDCP-Demo-App|RDCP Demo App]]
[[Trace-Propagation-Demo|Trace Propagation Demo]]

WRONG – will not work:

[[examples/RDCP-Demo-App]]
[[examples/Trace-Propagation-Demo]]

Why: GitHub Wiki flattens all pages regardless of git repo folder structure. All pages are accessible by filename only.

Standard Markdown links: Use only for repo docs or external URLs:

[Protocol Spec](https://github.com/mojoatomic/rdcp/blob/main/docs/rdcp-protocol-specification.md)

Never use:

  • raw.githubusercontent.com/wiki/ URLs (always shows raw markdown)
  • .md extension in wiki URLs (renders incorrectly)

GitHub Wiki Links - Definitive Rules

  1. Root-level pages: Use [[Page-Name|Display Text]]
  2. Subdirectory pages: Use [Display Text](subdir/Page-Name)
  3. Never use: [[subdir/Page-Name]] (doesn't work)
  4. Never use: raw.githubusercontent.com URLs
Clone this wiki locally