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 TODOs #99

Open
5 tasks
willfindlay opened this issue Nov 5, 2021 · 0 comments
Open
5 tasks

Documentation TODOs #99

willfindlay opened this issue Nov 5, 2021 · 0 comments
Labels
aya This is about aya (userspace) aya-bpf This is about aya-bpf (kernel) documentation Improvements or additions to documentation
Milestone

Comments

@willfindlay
Copy link
Member

This is a general-purpose tracking issue for several areas of improvement in Aya's documentation. I'm planning on spending some cycles on some of these over the next couple of weeks. If anyone has any comments/suggestions on something to add or change here, do let me know.

Short-term goals (to help new contributors):

  • Add an ARCHITECTURE.md file detailing the architecture of the project
  • Add a description of steps needed to 1) implement a new program type; and 2) implement a new map type to CONTRIBUTING.md

Long-term goals (to help library users):

  • Document every public-facing part of the userspace API
  • Document every public-facing part of aya-bpf
  • It probably also would make sense to #![deny(missing_docs)] at that point
@dave-tucker dave-tucker added aya This is about aya (userspace) aya-bpf This is about aya-bpf (kernel) documentation Improvements or additions to documentation labels Jan 11, 2022
@dave-tucker dave-tucker added this to the Aya 1.0 milestone Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aya This is about aya (userspace) aya-bpf This is about aya-bpf (kernel) documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants