To try out Doclin, install the extension in VS Code. Link to VS Code Marketplace.
Currently only supports VS Code, but to be extended to other IDEs once we validate the concept.
The purpose of this tool is to build code knowledgebase easily. Traditional code documentation methods are very inefficient. Developers write the documentation simultaneously as their code, which often results in documents that are time-consuming, unhelpful, and missing important points. Above all, it gets out of date quickly and becomes a burden to maintain it. We realized it is more helpful to document the answers when someone asks a question or faces a problem. This ensures the documentation is more meaningful, and we can spend less time writing documentation.
Doclin is still in a very early stage. If you like the idea, please star the repo to show support and use the discussions tab to leave feedback.
Ask questions on code from your IDE!\
Get answers in real-time.\
Discussions stay coupled with the code.\
cd api
npm install
npm run watch
npm run dev
cd extension
npm install
On Visual Studio Code, open the repository. Then on the top bar, select Run, then Start Debugging (F5).
See CONTRIBUTING.md for ways you can contribute to Doclin.