Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Core Concepts page/sub-pages #37

Open
smckeon-so opened this issue Jan 23, 2025 · 0 comments
Open

Create Core Concepts page/sub-pages #37

smckeon-so opened this issue Jan 23, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@smckeon-so
Copy link
Collaborator

smckeon-so commented Jan 23, 2025

Our target structure is as follows for the core concepts section. This section will pull content from many different place to summarize out code Aranya concepts

  • Core concepts (break down into sub-pages)
    • Terminology section from overview.md

    • Architecture

      • Arch diagram
        • Breakdown of components from overview.md (do not separate by on-graph/off-graph; instead, combine into single list!)
      • Control plane/data plane from overview.md
    • Graph

    • Access management (Control Plane)

      • Policy (use content with code from wiki page here (?) and reference to "Policy" chapter for more details)
        • Default policy summary + reference
        • Default crypto
      • Entity/user/device
      • Custom roles (pending spec)
      • Revocation
    • Real-time data exchange (Data Plane)

      • Overview (from wiki doc)
        • References to "AFC" in wiki doc apply also to Quic channels, so just replace "AFC" with "Aranya channels" for general use
      • Creating a channel (combining from overview.md and wiki doc)
      • Sending data (combining from overview.md and wiki doc)
      • AFC vs. Quic channels
        • Mostly just underlying transport, but include how that leads to other differences (like cert management)
      • Channels crypto
@smckeon-so smckeon-so added the documentation Improvements or additions to documentation label Jan 23, 2025
@smckeon-so smckeon-so added this to the Open-Source Aranya Docs milestone Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants