search

atsign-foundation / at_protocol

The open source repository for the atProtocol specification and supporting documentation
https://docs.atsign.com
BSD 3-Clause "New" or "Revised" License
10 stars 7 forks source link

General Key format added to spec #46

Open XavierChanth opened 1 year ago

XavierChanth commented 1 year ago

Is your feature request related to a problem? Please describe.

When explaining the underlying key structure, it was very difficult until I pulled up this old slidedeck: CleanShot 2023-03-03 at 16 03 10

Describe the solution you'd like

A general format key listed before the 5 variations, preferably as a diagram, and avoiding heavy regex syntax. (The idea is that it would give you a general understanding of the format, before reading about each one's details)

Describe alternatives you've considered

No response

Additional context

Would love some feedback on this idea, I know something like this isn't necessary in a specification, but it would make the specification a lot more understandable.

gkc commented 1 year ago

I've covered this in a larger update to the protocol spec. Keeping in sprint but reducing SP to 0

gkc commented 1 year ago

Didn't get as far as getting changes reviewed in PR59; moving to PR60 for completion

XavierChanth commented 1 year ago

Can this be closed @gkc

gkc commented 1 year ago

Not yet; didn't get more time on this in last couple of sprints, will prioritize the work to finish off my in-flight protocol spec update this week