Closed
Conversation
Create a new how-to guide that teaches developers how to practically use the Workflow SDK APIs: - Getting started with workflow scripts - Querying and sending HTTP requests - Creating and managing security findings - Accessing project information - Using environment variables - Performing network operations - Executing GraphQL queries - Working with hosted files - Common patterns and best practices The guide complements existing reference documentation with practical examples and step-by-step instructions for common tasks. It covers requests, findings, projects, environment, net, and graphql modules with working code examples. Update guides sidebar navigation to include the new Workflow SDK guide under Backend Guides. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
caidobot
temporarily deployed
to
main-a9967c0c4238d474 - doc-developer PR #104
Render
Destroyed
Member
|
Workflow SDK is out of scope in this doc. It's very similar to developer docs and doesn't deserve its own article. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR adds a comprehensive how-to guide for the Caido Workflow SDK that fills a documentation gap identified in the SDK reference surface.
What's New
New Guide:
src/guides/workflow_sdk.md(776 lines)A practical, goal-oriented how-to guide (following Diátaxis principles) that teaches developers how to effectively use the Workflow SDK. This guide complements the existing reference documentation with real-world examples and step-by-step instructions.
Topics Covered
Updates
.vitepress/sidebars/guides.tsto include the new guide under "Backend Guides > Workflow Scripts"Gap Analysis
The Workflow SDK reference documentation in
src/reference/sdks/workflow/contains 14 detailed reference pages (requests, findings, projects, environment, net, graphql, etc.), but lacked a corresponding how-to guide to teach practical usage patterns. This PR addresses that gap.Benefits
querying_requests.mdandreplay.md