Documentation is a very tedious process..
I believe there are 2 types of documentation on high level for a technical project.
Documentation for the end user. [applicable for almost all the projects]
- Technical documentation for the developers and maintainers. [applicable mostly for long-term
- projects] keeping comments in our code describing what it does is an example of 2nd type. I wanted to make the development journey easier by having a live documentation engine attached to our IDEs
What it does
I have created a VsCode extension, which is directly integrated to slack.
- settings screen to add custom bot tokens.
- need a git repo => uses the name of repo to create a repo channel in slack.
- documentation/ dev-logs of each file is represented as a thread in slack.
- tagging + filtering based on tags
- quick help tags
- OpenAI based code description
- For testing, Join My Workspace [default xapp and xoxb]: https://join.slack.com/t/hackathon-idea/shared_invite/zt-110gur9ac-k0k8eZeMwOl~~PxkOwCpXg
- Install the extension "Black Box"
- open any git repo in vscode [repo I used in demo => https://github.com/solid-droid/SimpleML]
- press CTRL + M
- to configure your own workspace, create a bot with permissions mentioned in the demo in your workspace => add the bot token(OAuth) and app token(websocket) in extension settings.
How we built it
- uses slack/web-api
- uses slack websocket
- openAI codex for code description