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

[Documentation] Document existing APIs which are already in-place #191

Open
ivmarkov opened this issue Jun 22, 2024 · 0 comments
Open

[Documentation] Document existing APIs which are already in-place #191

ivmarkov opened this issue Jun 22, 2024 · 0 comments

Comments

@ivmarkov
Copy link
Contributor

The following older sections of the code (pre 2024) need a lot more documentation:

  • IM layer (partially). Stuff like the handlers, objects, encoding module and others
  • SC layer - all of it
  • Crypto code
  • QR code
  • ACLs
  • Fabrics
  • Maybe more?
  • Sessions code in the transport layer, and possibly packet parsing / creation

I suggest we just add it over time. I can do IM layer and Sessions code as in the meantime my code contributions there prevail over the original code, and there, the complexity is a bit bigger.

I'll start opening PRs with this.

@ivmarkov ivmarkov changed the title [Documentation] [Documentation] Document existing APIs which are already in-place Jun 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant