chore: Plugin system documentation #446
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
j-lanson
added
type: chore
mchernicoff
previously requested changes
Sep 26, 2024
alilleybrinker
changed the title
alilleybrinker
approved these changes
Oct 10, 2024
j-lanson
commented
Oct 10, 2024
This commit introduces the initial documentation for the plugin system. There is still more to do to improve the docs, especially to document the query API for those who want to write plugins _without_ using an SDK, but this is at least a good starting point. Signed-off-by: Andrew Lilley Brinker <[email protected]> Signed-off-by: Julian Lanson <[email protected]>
alilleybrinker
force-pushed
the
docs/plugin-system
branch
from
92b4476 to
c9cd0ce
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not exactly ready for merge, but ready for the prose to start being looked at.
Lots of documentation on the plugin system for users, how to use the SDK, and a policy expression reference.
Has a lot of
@Todos for wiring up hyperlinks. Not sure if our API docs will be available on a website now that we aren't going to publish tocrates.io.Also structure is kind of weird right now because I didn't actually put the "for users" stuff in
for-users.md, I just put it right in theindex.md. Let me know if you have opinions on what should be split out into separate files.Resolves #443 . Resolves portions of #396 that I don't want to split out into separate issues.