cryspen / cryspen/mls-partial

Missing dicussion of External Proposals and validating incoming External Commits

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
F*
Stars
0
Forks
2
PR merge metrics
No merged PRs in 30d

Description

I would take sections: "8. Joining via Annotated Welcome" and "9. Joining via External Commit" and stick them under a new section:

```
# Joining a group

## Joining via Annotated Welcome

## Joining via External Proposal

Partial MLS clients can join a room by sending an External Proposal, with the `new_member_proposal` SenderType, as described in {{Section 12.1.8 of !RFC9420}}. If the external add proposal is accepted by a member of the group, the Partial MLS client will receive an Annotated Welcome. [Maybe add some text about detecting that the group can deliver Annotated Welcomes before sending the External Proposal].

## Joining via External Commit
```

Then I would add a short section under "Annotated Commit" called "Annotated External Commit", and describe what is different (resolution_index maybe?).

Contributor guide

Open the contributing guide

Research direction

Start by locating the document sections titled "8. Joining via Annotated Welcome" and "9. Joining via External Commit", then read Section 12.1.8 of RFC9420 for External Proposals. Reorganize the joining material under a new "Joining a group" section, add the External Proposal content, and document the differences for an "Annotated External Commit", including resolution_index if applicable.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
40/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.