Record your screentoDocument your code
ViDoc is an IDE extension designed to improve your your documentation workflow. It allows you to effortlessly record your screen and voice into your editor, providing context and insightful commentary to your code. This video commentary is then embedded directly into the code itself for for others to see.
Getting Started
Install Extension
Go to the VSCode Extension Marketplace and download the ViDoc extension. It's free so why not give it a try?
Download VSCode ExtensionAdjust Config
Setup the extension to your liking. You can choose to record into the Vidoc Cloud for free, or use your existing S3 bucket. You can also start by storing the videos in the repository itself.
Record
Explain your code as you would to a colleague. Your file will automatically be annotated with your recording.
How to configure Vidoc
Data Storage Autonomy
You can configure by adding a .vidocconf.json file at the root of your repository. The following configurations are supported:
- Store on Vidoc.Cloud.
- Vidocs can be stored inside the Vidoc.Cloud platform. This is the easiest way to get started if you don't want to deal with S3 buckets or you are working in a team.
- Store in Repo.
- By default vidoc works also without a config file. In that case, the videos will be stored in the repository itself. This is the easiest way to get started.
- Store in S3.
- If you want to store the videos in an S3 bucket, you can configure the extension to do so. Credentials can be shared using a gitignored .vidocsecrets file.
"projectId": "123"
"savingStrategy": {
"region": "eu-central-1",
"accessKeyId": "${ACCESS_KEY_AWS}",(.vidocsecrets)
"secretAccessKey": "${SECRET_KEY_AWS}"(.vidocsecrets)
How to contribute
Open Source First!
Vidoc is open source at its core, promising unrestricted access to every user. While cloud services are available, they're optional - Vidoc is committed to providing an exceptional, community-driven user experience right out of the box.
You see this? We gotta change this!