Skip to content

Commit 257dda0

Browse files
committed
Add v1 documentation information architecture
1 parent 81bf801 commit 257dda0

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

docs/v1/README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# CoreLink v1 developer documentation
2+
3+
**Maturity: Alpha documentation / draft contract**
4+
5+
This tree targets the API Contracts repository's immutable
6+
`v1.0.0-draft` baseline. The reviewed public slice currently covers **Device**
7+
and **Command** resources plus a canonical event envelope. Tenant provisioning,
8+
integration callbacks and privileged administration are outside the public v1
9+
boundary until separately reviewed.
10+
11+
## Start here
12+
13+
| Topic | Status | Source |
14+
| --- | --- | --- |
15+
| Public Device + Command API | Alpha / draft | [Public OpenAPI](https://github.com/CoreLinkPlatform/api-contracts/blob/main/openapi/corelink-public-v1.yaml) |
16+
| Event envelope | Alpha / draft | [AsyncAPI](https://github.com/CoreLinkPlatform/api-contracts/blob/main/asyncapi/corelink-events-v1.yaml) |
17+
| Authentication and tenant scope | Planned documentation | Contract security definitions + runtime evidence |
18+
| TypeScript SDK | Prerelease Alpha | [sdk-typescript](https://github.com/CoreLinkPlatform/sdk-typescript) |
19+
| Python SDK | Prerelease Alpha | [sdk-python](https://github.com/CoreLinkPlatform/sdk-python) |
20+
| Java SDK | Scaffold / Planned | [sdk-java](https://github.com/CoreLinkPlatform/sdk-java) |
21+
| CLI | Scaffold / Planned | [cli](https://github.com/CoreLinkPlatform/cli) |
22+
| MCP server | Scaffold / Planned | [mcp-server](https://github.com/CoreLinkPlatform/mcp-server) |
23+
| Mock server | Scaffold / Planned | [mock-server](https://github.com/CoreLinkPlatform/mock-server) |
24+
25+
## Navigation contract
26+
27+
### 1. Start here
28+
Concepts, authentication, tenant isolation, canonical identifiers and first
29+
verified API call. Content beyond the linked contract is **Planned**.
30+
31+
### 2. Guides
32+
Device registration/lifecycle and commands are first because they are in the
33+
current public draft. Telemetry, digital twin, webhooks and integrations remain
34+
**Planned** until their public contracts and runtime parity are evidenced.
35+
36+
### 3. How-to
37+
Partner/operator procedures will be added only with reproducible prerequisites,
38+
failure handling and test evidence.
39+
40+
### 4. Reference
41+
Use the versioned files in
42+
[`api-contracts`](https://github.com/CoreLinkPlatform/api-contracts). This
43+
repository explains usage; it does not fork schema definitions.
44+
45+
### 5. SDKs and tools
46+
TypeScript/Python are generated prerelease clients. Other tool repositories are
47+
not installable supported releases today.
48+
49+
### 6. Examples
50+
Examples must pin their contract baseline and tested runtime/SDK version.
51+
52+
### 7. Operations
53+
Release/migration/troubleshooting material must name its owner, rollback or
54+
recovery path, and evidence when applicable.
55+
56+
## Contract rules carried into docs
57+
58+
- Public device identity is `corelink_device_id`.
59+
- Provider/connector identifiers are implementation details.
60+
- Every state-changing example must describe tenant scope, authorization,
61+
idempotency and expected problem responses.
62+
- A draft or scaffold is never described as Stable/supported.

0 commit comments

Comments
 (0)