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 Technical API documentation page/sub-pages for the doc site #41

Open
smckeon-so opened this issue Jan 23, 2025 · 1 comment
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@smckeon-so
Copy link
Collaborator

We have generated API docs for the Rust and C code. We need to find a way to surface this information to the docs site visitor.

It may be that we want to link out to selected docs on docs.rs
https://docs.rs/aranya-client/latest/aranya_client/
https://docs.rs/aranya-daemon/0.4.0/aranya_daemon/

Instead of generating, consolidating and hosting them ourselves on the doc site.

  • Technical APIs
    • Rust API
    • C API
@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
@gknopf-aranya
Copy link
Contributor

@smckeon-so, @ycarmy we're generating a local Doxygen docs site for the C API. Would this be worth hosting somewhere and pointing to from this docs site?

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