Skip to content

Envelope inconsistencies #18

Description

@vasco-santos
  1. The term “Envelope” is used without any immediate definition in the doc; this makes it harder for first-time readers who may not want to switch to other specs to understand it.

👉 Suggestion:

Add a very short explanatory sentence or paragraph early on, e.g.:

“An envelope is a data structure that wraps a payload and associated metadata (such as a signature and tag) into a single serializable unit for secure delegation and verification.”


  1. The spec uses both “UCAN Envelope Tag” and “Type Tag” interchangeably, which can confuse the reader.
  • “Envelope Tag” seems clearer and closer to the concept being described; “Type Tag” is more generic and could imply other uses.

👉 Suggestions:

  • Pick one consistent name across the spec—“Envelope Tag” is preferable for clarity.
  • Add a short description in situ (without requiring jumping to UCAN main spec) explaining what the tag represents:

“An Envelope Tag identifies the type of content encoded within the envelope, guiding its interpretation.”


Happy to open a PR if you agree this is helpful

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions