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

Document public / internal API split #1841

Open
SWilson4 opened this issue Jul 11, 2024 · 1 comment
Open

Document public / internal API split #1841

SWilson4 opened this issue Jul 11, 2024 · 1 comment
Assignees
Labels
documentation Changes only about documentation

Comments

@SWilson4
Copy link
Member

We have two liboqs APIs: the public one, exposed to users via oqs.h, and the internal one, used for non-exposed common code (e.g., SHA3). We should document this API split for the benefit of both users and developers.

Feedback welcome on where to put this documentation. It seems like similar docs live in the wiki at the moment---is this the best place or should we create a tracked markdown file within the repo?

@SWilson4 SWilson4 added the documentation Changes only about documentation label Jul 11, 2024
@SWilson4 SWilson4 self-assigned this Jul 11, 2024
@baentsch
Copy link
Member

This must be in the repo, not in the Wiki; how otherwise will different API (concepts) be winding up in release documentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only about documentation
Projects
Status: Todo
Development

No branches or pull requests

2 participants