A public directory of learning resources related to Caido, helping users explore tutorials, labs, videos, and other educational content.
-
Clone the repository
-
Install dependencies:
pnpm install
-
Start the development server:
pnpm dev
To contribute content to Caido Atlas:
-
Create a new JSON file in the appropriate directory:
/content/official/
for Caido team-created content/content/community/{author}/
for community-submitted content, where{author}
is your name or organization
Example:
/content/community/john-doe/my-workflow.json
-
Use the following JSON format:
{
"title": "Your Resource Title",
"description": "A brief description of the resource.",
"format": ["article", "video", "lab"],
"languages": ["en"],
"tags": ["tag1", "tag2"],
"author": "Your Name",
"url": "https://example.com",
"publishedAt": "2025-05-06"
}
Required fields:
title
: The name of your resourcedescription
: A concise description (1-2 sentences)format
: Array of content types (article, video, lab)languages
: Array of language codes (e.g., "en" for English)tags
: Array of relevant tags for discoverabilityauthor
: Your name or organizationurl
: The URL where the content can be foundpublishedAt
: Date when the resource is published to Caido Atlas (yyyy-mm-dd)
- Submit a pull request with your changes.
- Use lowercase kebab-case for filenames (e.g.,
aws-signature-workflow.json
) - Keep descriptions concise (1-2 sentences)
- Use relevant tags to help with discoverability
- Ensure all external links are valid and accessible
- Follow the JSON formatting guidelines