docs(messaging): move remaining specs from logos-messaging/specs#346
Conversation
6f4109b to
ef16232
Compare
…pecs Pristine copies of the last messaging specs not covered by #315/#331, imported as-is from logos-messaging/specs so the adaptation diff is isolated in the following commit: - chat-framework (logos-messaging/specs#81) - privatev1 (logos-messaging/specs#93) - introduction-encoding (logos-messaging/specs#101) - contentframe (logos-messaging/specs#82) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Converts the YAML front matter of the freshly imported specs to the canonical `| Field | Value |` metadata table (status: raw), matching #315/#331. Slugs and timelines are left to the build-time generators. Also rewrites cross-references that pointed at the old source repos to their new logos-lips locations, using repo-relative links (matching how existing specs cross-link, e.g. reliable-channel-api -> ./segmentation.md and rln-relay -> ../../../anoncomms/...): - waku-org/specs segmentation/contentframe/chatdefs → ./<spec>.md - vacp2p/rfc-index sds → ../../anoncomms/raw/sds.md - privatev1 segmentation TODO link flattened to the segmentation spec - contentframe domain-registry entry #1 repointed to logos-co/logos-lips Notes: - contentframe had an empty `name:` in source; set to "Chat Content Frames" (per logos-messaging/specs#82 title). - introduction-encoding had no `editor:`; populated from its `contributors:` list. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ef16232 to
2884ef3
Compare
fbarbu15
left a comment
fbarbu15
left a comment
There was a problem hiding this comment.
LGTM, just some small findings
| # CHAT-FRAMEWORK | ||
|
|
||
| | Field | Value | | ||
| | --- | --- | | ||
| | Name | A modular framework for defining chat protocols | | ||
| | Status | raw | | ||
| | Type | RFC | | ||
| | Category | Informational | | ||
| | Tags | chat | | ||
| | Editor | Jazz Alyxzander <jazz@status.im> | |
There was a problem hiding this comment.
In the previous repo the folder structure helped to separate:
- Standards track vs Informational
- Application (Chat) vs Core(Delivery)
WIthout these its harder to navigate.
[Sand] Consider separating Delivery and Chat. The specifications are mutually exclusive; combining only adds confusion.
There was a problem hiding this comment.
@fbarbu15 what do you think about this?
The current folder structure is per-team (e.g. there's anoncomms, messaging and research), but it doesn't make much sense for an external reader. Maybe indeed we should rather make dir-structure follow logical areas of application?
There was a problem hiding this comment.
(I'll keep it as is in this PR anyway though, this is a separate discussion)
There was a problem hiding this comment.
@igor-sirotin I'm ok with that, blockchain team asked for a similar folder structure like they had in notion and it looks like this now in LIPS
So if you guys need to categorize specs in any other way feel free to do it or lmk and I can look into it.
Co-authored-by: Jazz Turner-Baggs <473256+jazzz@users.noreply.github.com>
3 participants
Follow-up to #315 (and #331 for segmentation): moves the last messaging specs that still lived only in
logos-messaging/specsintodocs/messaging/raw/. YAML front matter is converted to the canonical| Field | Value |metadata table (status: raw); slugs and timelines are left to the build-time generators, matching #331.Split into two commits for review: the first imports each spec verbatim from
logos-messaging/specs, the second isolates the logos-lips adaptations (metadata table + cross-reference rewrites).Specs moved
chat-framework.mdprivatev1.mdintroduction-encoding.mdcontentframe.mdNotes
contentframehad an emptyname:in source; set to "Chat Content Frames" (per PR Add RLNv2 to TheWakuNetwork #82 title).introduction-encodinghad noeditor:; populated from itscontributors:list.waku-org/specs,vacp2p/rfc-index) are rewritten to their new logos-lips locations using repo-relative links.standards/application/tor-push.mdis not moved: Migrate logos-messaging/specs into docs/messaging/ #315 already classified it as superseded by the existingdocs/anoncomms/raw/gossipsub-tor-push.md(same protocol/editor, far more developed), so re-adding it would duplicate that spec.standards/core/enr.mdin the source repo is the Waku v2 ENR spec and already exists here asdocs/messaging/draft/31/enr.md, so it was not moved.🤖 Generated with Claude Code