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

Tracking Issue: More Docs! #525

Open
1 task
alilleybrinker opened this issue Oct 25, 2024 · 3 comments
Open
1 task

Tracking Issue: More Docs! #525

alilleybrinker opened this issue Oct 25, 2024 · 3 comments
Labels
tracking-issue This issue tracks a larger task.

Comments

@alilleybrinker
Copy link
Collaborator

We need more documentation! This is a general purpose statement that would always be true, but in particular we've added a bunch of new concepts and functionality with the introduction of the plugin system, and it's not all documented clearly for users. This issue is intended to track documentation we ought to write.

  • Explain targets structs and how they're passed to default queries
@alilleybrinker alilleybrinker added the tracking-issue This issue tracks a larger task. label Oct 25, 2024
@ninaagrawal
Copy link

sdk/rust/src/mock.rs should have a comment at the top explaining purpose of the file. More comments throughout the file would be good

@ninaagrawal
Copy link

Giving more details about what configs are for plugins would be useful

@ninaagrawal
Copy link

For plugins/affiliation/src/until/org_types.rs, an annotation explaining what hosts are might be helpful. I think I saw some examples in the other files within the src directory but explaining what hosts are would still be good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tracking-issue This issue tracks a larger task.
Projects
Status: Todo
Status: No status
Development

No branches or pull requests

2 participants