Skip to content
This repository was archived by the owner on Aug 15, 2025. It is now read-only.

Commit ed07501

Browse files
committed
unify "header" format across spec docs
1 parent e9f8b45 commit ed07501

File tree

2 files changed

+33
-18
lines changed

2 files changed

+33
-18
lines changed

docs/Protocol Specifications/P2 Extensions/chat.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,22 @@
22
title: polyproto-chat
33
---
44

5-
# P2 Extension: polyproto-chat
5+
# p2-Extension: polyproto-chat
66

7-
!!! bug "TODO"
7+
- Namespace: `chat`
8+
- Version: `v0.1.0-alpha.1`
9+
- API version: `v0.1.0-alpha.1`
10+
- API documentation: [apidocs.polyproto.org](https://apidocs.polyproto.org)
11+
- Dependencies:
12+
- [polyproto](https://docs.polyphony.chat/Protocol%20Specifications/core/)@1.0.0-beta.1
13+
- [mls](https://docs.polyphony.chat/Protocol%20Specifications/P2%20Extensions/mls/)@0.1.0-alpha.1
814

9-
TODO: This is a work in progress. Chat-related content is currently being migrated over from the polyproto-core specification.
10-
This document is not at all complete.
15+
!!! warning
16+
17+
The polyproto-chat specification document is in an **alpha** phase. Please report any inconsistencies,
18+
missing or duplicate information and other mistakes at [github.com/polyphony-chat/docs/issues](https://github.com/polyphony-chat/docs/issues).
19+
20+
[Semantic versioning v2.0.0](https://semver.org/spec/v2.0.0.html) is used to version this specification.
1121

1222
## 4. Federating direct/group messages
1323

@@ -80,8 +90,8 @@ Alice Server
8090
| Bob's KeyPackages | |
8191
|<---------------------------------------------| |
8292
| | |
83-
| Verify Bob's KeyPackages | |
84-
| ----------------------- | |
93+
| Verify Bob's KeyPackages | |
94+
| ------------------------ ||
8595
| | | |
8696
|<----------------------- | |
8797
| | |
@@ -114,8 +124,8 @@ Alice (gatekeeper) Server
114124
| Bob's KeyPackages | | |
115125
|<-------------------------------------------------| | |
116126
| | | |
117-
| Verify Bob's KeyPackages | | |
118-
|------------------------ | | |
127+
| Verify Bob's KeyPackages | | |
128+
| ------------------------ || |
119129
| | | | |
120130
|<----------------------- | | |
121131
| | | |
@@ -137,8 +147,8 @@ Alice (gatekeeper) Server
137147
| Charlie's KeyPackages | | |
138148
|<-------------------------------------------------| | |
139149
| | | |
140-
| Verify Charlie's KeyPackages | | |
141-
|---------------------------- | | |
150+
| Verify Charlie's KeyPackages | | |
151+
| ---------------------------- || |
142152
| | | | |
143153
|<--------------------------- | | |
144154
| | | |

docs/Protocol Specifications/P2 Extensions/mls.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,23 @@
22
title: polyproto-mls
33
---
44

5-
# P2 Extension: polyproto-mls
5+
# p2-Extension: polyproto-mls
66

7-
!!! bug "TODO"
7+
- Namespace: `mls`
8+
- Version: `v0.1.0-alpha.1`
9+
- API version: `v0.1.0-alpha.1`
10+
- API documentation: [apidocs.polyproto.org](https://apidocs.polyproto.org)
11+
- Dependencies:
12+
- [polyproto](https://docs.polyphony.chat/Protocol%20Specifications/core/)@1.0.0-beta.1
813

9-
This is a work in progress. MLS-related content is currently being migrated over from the polyproto-core specification.
10-
This document is not yet complete.
14+
!!! warning
15+
16+
The polyproto-mls specification document is in an **alpha** phase. Please report any inconsistencies,
17+
missing or duplicate information and other mistakes at [github.com/polyphony-chat/docs/issues](https://github.com/polyphony-chat/docs/issues).
1118

12-
**v0.1.0-alpha.1** - Treat this as an unfinished draft.
1319
[Semantic versioning v2.0.0](https://semver.org/spec/v2.0.0.html) is used to version this specification.
14-
The version number specified here also applies to the API documentation.
1520

16-
- [P2 Extension: polyproto-mls](#p2-extension-polyproto-mls)
21+
- [p2-Extension: polyproto-mls](#p2-extension-polyproto-mls)
1722
- [1. Encryption](#1-encryption)
1823
- [1.1. KeyPackages](#11-keypackages)
1924
- [1.1.1 Last resort KeyPackages](#111-last-resort-keypackages)
@@ -128,7 +133,7 @@ polyproto servers and clients employing encryption must support multi-device use
128133
assigns each device a unique `LeafNode` and prohibits key sharing across devices. Each device offers
129134
distinct KeyPackages and an own ID-Cert.
130135

131-
---
136+
---
132137

133138
TODO: Integrate this from the core spec
134139

0 commit comments

Comments
 (0)