{"id":18264405,"url":"https://github.com/caido/documentation","last_synced_at":"2025-04-04T21:30:28.307Z","repository":{"id":43409311,"uuid":"459665317","full_name":"caido/documentation","owner":"caido","description":"📙 User documentation for Caido","archived":false,"fork":false,"pushed_at":"2025-04-01T23:57:48.000Z","size":50798,"stargazers_count":25,"open_issues_count":22,"forks_count":18,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-02T20:54:35.379Z","etag":null,"topics":["caido","documentation","user"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/caido.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-15T16:44:22.000Z","updated_at":"2025-04-01T14:03:23.000Z","dependencies_parsed_at":"2023-12-20T11:12:47.422Z","dependency_job_id":"5818861b-bfc0-4d9a-a3e0-f3fcc94c9db8","html_url":"https://github.com/caido/documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caido%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caido%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caido%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caido%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caido","download_url":"https://codeload.github.com/caido/documentation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247251937,"owners_count":20908595,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["caido","documentation","user"],"created_at":"2024-11-05T11:14:33.628Z","updated_at":"2025-04-04T21:30:23.298Z","avatar_url":"https://github.com/caido.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg width=\"1000\" alt=\"image\" src=\"https://user-images.githubusercontent.com/6225588/211916659-567751d1-0225-402b-9141-4145c18b0834.png\"\u003e\n\n  \u003cbr /\u003e\n  \u003cbr /\u003e\n  \u003ca href=\"https://caido.io/\"\u003eWebsite\u003c/a\u003e\n  \u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n  \u003ca href=\"https://dashboard.caido.io/\"\u003eDashboard\u003c/a\u003e\n  \u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n  \u003ca href=\"https://links.caido.io/roadmap\"\u003eRoadmap\u003c/a\u003e\n  \u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n  \u003ca href=\"https://github.com/caido/caido/tree/main/brand\"\u003eBranding\u003c/a\u003e\n  \u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n  \u003ca href=\"https://links.caido.io/www-discord\" target=\"_blank\"\u003eDiscord\u003c/a\u003e\n  \u003cbr /\u003e\n  \u003chr /\u003e\n\u003c/div\u003e\n\n## 👋 Welcome\n\nWelcome to the Caido documentation repository!\n\nTo contribute to our documentation, please see the contribution section below.\n\nPlease note that you'll also have to sign a [contributor license agreement](https://cla-assistant.io/caido/documentation) when submitting a PR.\n\nThanks in advance for your contributions!\n\n## 🔧 Contribution\n\nWe've taken the time to set up Codespaces on this repo, which makes setting up a local copy of [the documentation site](https://docs.caido.io), viewing your changes live, and creating a pull request back to the `main` branch SUPER easy. **The entire process will take less than 5 clicks and less than 5 minutes.**\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://www.loom.com/share/83b80d9f19db4ae3aab5eb831231d476\" title=\"Process\"\u003e\u003cimg src=\"https://cdn.loom.com/sessions/thumbnails/83b80d9f19db4ae3aab5eb831231d476-with-play.gif\" alt=\"Video of the documentation steps\" /\u003e\u003c/a\u003e\n\u003c/div\u003e\n\nAn overview of the process is as follows:\n\n1. Create a fork of the repository\n1. Create a new branch\n1. Create a `codespace` on this branch (the `codespace` settings will configure everything for you)\n1. Make changes and view your changes on the local version of the documentation site found in the `ports` section of the VS Code interface\n1. Commit changes to the branch using the VS Code interface\n1. Create a pull request to main via VS Code interface or normal GitHub interface\n\nHere is a link to our [style guide (WIP)](style-guide.md).\n\n\u003e Accounts get 60 hours per month of `codespace` run-time before you start getting charged; so don't forget to stop/delete your codespace after you've made your modification!\n\n## 💚 Community\n\nCome join our [Discord](https://links.caido.io/www-discord) community and connect with other Caido users! We'd love to have you as part of the conversation and help with any questions you may have.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaido%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaido%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaido%2Fdocumentation/lists"}