docs: clarify workflow YAML locations and custom additions #1
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.
Description
I wanted to add my own tools to
secator
, but I noticed that the documentation was missing details on two essential points:Availability of external commands: It needed clarification that commands must be available in the
PATH
to be executed correctly bysecator
. I added an explanation and a command (which
) to help users verify command availability.Location of workflow YAML files: The documentation didn’t specify where to find existing workflow YAML files. I included their location in the library (
python3.11/site-packages/...
) and added a command to locate them easily. I also explained how and where to add custom workflows (~/.secator/templates/**
).PS
In my opinion, the default workflows should ideally be placed in
~/.secator/templates
instead of remaining in the installed library files. This would make it much easier for users to modify or remove them, as managing them directly within the library is not very practical.Thank you so much for your work! Adding tools to
secator
is incredibly cool and straightforward thanks to your approach. 😊