Separate doc bots for services and workflows - #2
Conversation
Wiz Scan Summary
To detect these findings earlier in the dev lifecycle, try the Wiz Code extension for VS Code, JetBrains, or Visual Studio. |
![wiz-8f2719713e[bot]](https://avatars.githubusercontent.com/u/38518764?s=60&v=4){kind=small}
There was a problem hiding this comment.
PII
More Details
| Attribute | Value |
|---|---|
| Data Classifier | PII/Name |
| Data Classifier ID | BUILTIN-125 |
Sampled Examples
| Key | Value | Row Number |
|---|---|---|
| by | S****y | 3 |
Rule ID: BUILTIN-125
To ignore this finding as an exception, reply to this conversation with #wiz_ignore reason
If you'd like to ignore this finding in all future scans, add an exception in the .wiz file (learn more) or create an Ignore Rule (learn more).
To get more details on how to remediate this issue using AI, reply to this conversation with #wiz remediate
There was a problem hiding this comment.
PII
More Details
| Attribute | Value |
|---|---|
| Data Classifier | PII/Citizenship |
| Data Classifier ID | BUILTIN-238 |
Sampled Examples
| Key | Value | Row Number |
|---|---|---|
| national | Aur*a | 9 |
Rule ID: BUILTIN-238
To ignore this finding as an exception, reply to this conversation with #wiz_ignore reason
If you'd like to ignore this finding in all future scans, add an exception in the .wiz file (learn more) or create an Ignore Rule (learn more).
To get more details on how to remediate this issue using AI, reply to this conversation with #wiz remediate
1 participant
This pull request updates the documentation to support two types of AI-assisted authoring workflows: BioCommons how-to guides and Nextflow DSL2 workflow READMEs. The changes clarify which files to use for each workflow, standardize file locations and names, and provide tailored instructions for both documentation types. The most important changes are:
General Documentation and Workflow Support:
README.mdnow covers both BioCommons how-to guides (inservice/) and Nextflow DSL2 workflow READMEs (inworkflow/), with clear instructions and quickstart guides for each.File Naming and Structure Updates:
llms.txtis nowservice/llm.txt, andGUIDE_CONTEXT.mdis nowservice/SERVICE_CONTEXT.md. Instructions and file tables in bothREADME.mdandAI_AUTHORING.mdhave been updated accordingly. [1] [2] [3] [4] [5]Nextflow Workflow Documentation Support:
workflow/folder, which provides conventions and workflow for documenting Nextflow DSL2 pipelines using the SIH template. This includes a dedicated quickstart and guidance for supplying source files as context.Clarifications and Improvements:
These changes make the repo more flexible and easier to use for different documentation scenarios, ensuring users select the correct files and instructions for their needs.