-
Notifications
You must be signed in to change notification settings - Fork 15
docs(cli): add docs for custom plugins #312
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
Conversation
IKatsuba
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some comments
matejchalk
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall I think this is a very good step-by-step guide. My only note on structure is I wouldn't include it the CLI README, because it's quite long and only relevant for plugin authors, making it more of an advanced topic. I would move into a separate Markdown file (e.g. docs/plugin-tutorial.md), and only include a link here.
Otherwise I had some more detailed notes in the comments.
|
I had more thoughts on the chapters "Scoring of audits" and "Attribution of audits"... I think it is a better learning if we direclty stick to the data structure and I arite more in the context of audits. So the new COT could look like this:
|
Co-authored-by: Matěj Chalk <[email protected]> Co-authored-by: Kateřina Pilátová <[email protected]>
Tlacenka
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it!
Just wondering whether the removal of the second file is intentional, the text seemed well split where the CLI was a high-level introduction and the main custom plugins was more of a tutorial. 🤔
Co-authored-by: Kateřina Pilátová <[email protected]>
Co-authored-by: Kateřina Pilátová <[email protected]>
Co-authored-by: Enea Jahollari <[email protected]>
Co-authored-by: Enea Jahollari <[email protected]>
Co-authored-by: Enea Jahollari <[email protected]>
Tlacenka
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good!
A few TODOs are still left (links to models). Is this desired?
Tlacenka
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Except for the todos, great improvement, well documented user journey towards custom plugins! 💯
This PR adds documentation about custom plugins to the cli docs.
Todos:
introduced more sections on data strucutres and added links to other docs.
closes #117