🚀 Doclin for VS Code - Collaborate Like Never Before!
Welcome to Doclin, your new favorite real-time commenting and discussion tool designed for codebases. We're here to make your life easier when working on complex codebases. We are in beta and always looking to improve, so we welcome your feedback - Share Your Thoughts
🌟 Use Cases
🔍 Ask Questions Without Leaving Your IDE:
Stumbled upon a complex piece of code? Just select the code, tag your team member on Doclin, and fire away your question. The Q&A stays with the code for future reference.
💬 Replace Inline Comments:
Tired of messy and outdated inline comments? Use Doclin's rich text editor and thread system to discuss and provide detailed comments on complex code in real-time.
🔁 Avoid Repeating Questions:
With Doclin, questions asked on a specific piece of code stay with the code. So, you might find your question has already been answered!
🧹 Prevent Unclean Code from Resurfacing:
Found some unclean code? Leave a comment suggesting a better alternative. Help future developers avoid the same pitfalls.
🚀 Getting Started
Install the Doclin extension in VS Code.
Open a folder or file where you want to leave a comment. For best results, use a git repository.
Open the Doclin extension from the left activity bar.
If you're using Doclin for the first time, you'll be prompted to create an organization and project. This creates a .doclin file in your directory. Push this to git so your teammates can collaborate with you on Doclin. Invite new members using the invite button.
Start using Doclin!
📝 How to Add a Comment
Open a file in VS Code with Doclin installed.
Highlight a piece of code and click Add Comment. You can do this in three ways:
Use the Add Comment button on the bottom-left status bar.
Right-click in VS Code and click Add Comment.
Use CTRL + SHIFT + P and type in Add Comment.
To mention your teammates, type @ followed by their names in the editor.
Click Submit. Mentioned users will be notified via email.
🔒 Security
Comment data is stored safely in the cloud to enable real-time collaboration in Doclin. Only you and the members you've added to your organization can access your data. Learn more at doclin.dev.
