Enumerate the primary end-to-end code paths

[gkc]

Is your feature request related to a problem? Please describe. We've reached a point where knowledge of how things hang together end-to-end is becoming a patchwork quilt in people's heads of what they have picked up from their own work, from documents, and from other people. Among other things, this clearly impacts the length of time it takes people to gain that knowledge, significantly reduces the likelihood of that knowledge being completely accurate, and impacts our ability to understand potential impact/blast-radius of changes to the codebase.

Describe the solution you'd like

• [Done] An enumeration of the primary code paths (see below)
• Brief documentation of those code paths
  • Diagram: Technology-agnostic high-level overview
  • Diagram: High-level block diagram with annotations
  • [Optional] Detailed flowchart / sequence diagrams as required

List

• [x] @alice share data with @bob (arguably the primary use case of the AtPlatform) (Pull Request)
• [ ] Onboarding an atSign
• [ ] Authentication: client to secondary server
• [ ] Authentication: secondary server to other secondary server
• [ ] Sharing data with various combination of primary attributes
• [ ] Deleting / unsharing data
• [ ] Sending notifications
• [ ] Receiving notifications
• [ ] Client-Secondary Synchronisation
• [ ] Switch atSign

[XavierChanth]

atsign.dev-3.0 has mermaid support

[gkc]

Awesome!

[gkc]

@XavierChanth how does the mermaid support work? Should I just add '''mermaid <content> blocks in my markdown files as one does for GitHub these days, and something else will take care of rendering etc during site publication?

[XavierChanth]

@gkc my preference:

In atsign.dev-3.0 create each diagram in a single markdown file under /layouts/shortcodes/mermaid

Example file: /layouts/shortcodes/mermaid/my-diagram.md

File content will be the usual format: ```mermaid // Diagram here ```

This setup will:

• Make sure it is easy to review in GitHub.
• Allow us to use the diagrams SUPER easily in the site.

Example syntax of inserting the diagram into a page on atsign.dev:

# enable this option in the front matter:
mermaid: true

# Then insert your diagram into the body:
{{% mermaid/my-diagram %}}

[gkc]

Got it - thanks!

[gkc]

5 SP this sprint. Estimate 8SP remaining work; time-boxing to 5SP next sprint also

[gkc]

Time-boxing effort for this sprint to 4SP