https://github.com/caido/doc-developer

📙 Developer documentation for Caido
https://github.com/caido/doc-developer

caido developer documentation

Last synced: about 2 months ago
JSON representation

📙 Developer documentation for Caido

• Host: GitHub
• URL: https://github.com/caido/doc-developer
• Owner: caido
• License: cc-by-4.0
• Created: 2024-09-08T15:29:31.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-04T23:16:03.000Z (about 2 months ago)
• Last Synced: 2024-11-05T00:21:17.451Z (about 2 months ago)
• Topics: caido, developer, documentation
• Language: TypeScript
• Homepage: https://developer.caido.io
• Size: 1.59 MB
• Stars: 2
• Watchers: 4
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


  


  


  Website

    •  

  Dashboard

    •  

  Roadmap

    •  

  Branding

    •  

  Discord

  


  




## 👋 Welcome

Welcome to the Caido developer documentation repository!

To contribute to our documentation, please see the contribution section below.

Please note that you'll also have to sign a [contributor license agreement](https://cla-assistant.io/caido/doc-developer) when submitting a PR.

Thanks in advance for your contributions!

## 🔧 Contribution

We'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.**



  



An overview of the process is as follows:

1. Create a fork of the repository

1. Create a new branch

1. Create a `codespace` on this branch (the `codespace` settings will configure everything for you)

1. Make changes and view your changes on the local version of the documentation site found in the `ports` section of the VS Code interface

1. Commit changes to the branch using the VS Code interface

1. Create a pull request to main via VS Code interface or normal GitHub interface

Here is a link to our [style guide (WIP)](style-guide.md).

> 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!

## 💚 Community

Come 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.