vexance / Stratustryke

A small work-in-progress modular cloud security tool
2 stars 0 forks source link

[STSK21] Detailed module use instructions #21

Open vexance opened 1 year ago

vexance commented 1 year ago

Moving forward, all modules must contain detailed step-by-step instructions on module setup/use prior to merge into the dev branch. This issue is opened to task documentation of current module instructions:

For example, Module._info['Details'] will contain a brief description of what is happening behind the scenes, and then any step-by-step instructions for use. Links used within the instructions should point to instructional documentation markdown within this repository (Links contained with the References can / should go to external sources).

vexance commented 1 year ago

Note: for modules with extensive / very long details for required setup and/or use, prepare a markdown doc within the Stratustryke/docs/ under a similar directory path to the module's search name. If a markdown doc is specified, the details field in the module's info can then simply reference the markdown doc.