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

chore(docs): developer docs on plugin system communication #728

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

j-lanson
Copy link
Collaborator

To start the hipcheck developer docs, I added a document and accompanying graphic explaining how Hipcheck core queries are conducted over gRPC.

@alilleybrinker I could use advice on where the .png / .drawio files should be stored in the site. I also need to set up to do local site dev to wire up this Markdown file to read the .png and be part of the Contributing page links.

@devin-b-lake @aamohd @ninaagrawal as the newer members on the team, I would appreciate if you read through the document and the graphic, and pointed out anything that was particularly confusing. The expectation is that someone would read it while looking through the functions it references.

@j-lanson j-lanson added type: chore Clean up or management task. product: website Relates to the Hipcheck website labels Dec 17, 2024
@j-lanson j-lanson added this to the 3.10.0 milestone Dec 17, 2024
@j-lanson j-lanson self-assigned this Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product: website Relates to the Hipcheck website type: chore Clean up or management task.
Projects
Status: Todo
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants