-
Notifications
You must be signed in to change notification settings - Fork 0
WARP
This page mirrors the repositoryβs WARP.md and provides development rules specific to the RDCP SDK.
- Canonical source: https://github.com/mojoatomic/rdcp/blob/main/WARP.md
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.
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)
- Root-level pages: Use
[[Page-Name|Display Text]]
- Subdirectory pages: Use
[Display Text](subdir/Page-Name)
- Never use:
[[subdir/Page-Name]]
(doesn't work) - Never use:
raw.githubusercontent.com
URLs
Getting Started: Installation β’ Basic Usage β’ Authentication
Migration: From Manual Implementation β’ Framework Examples β’ Publishing Guide
Protocol: RDCP v1.0 Specification β’ Implementation Guide β’ API Reference
π Home | π¦ NPM Package | π GitHub | π Issues
RDCP SDK v1.0.0 - Runtime Debug Control Protocol implementation for JavaScript/Node.js applications
- Implementation-Status
- JavaScript-vs-TypeScript-Boundaries
- Core-Package-Boundaries
- Publishing-Setup
- Contributing
- API-Reference
- Protocol Specification
- Implementation Guide
- RDCP-Primitive-Types
- Protocol-Schemas
- Protocol-Error-Codes
- API-Reference
Version: 1.0.0
Protocol: RDCP v1.0
License: Apache-2.0