Knowl AI: Generate & Manage Code Docs with Rich Text Editor
Introducing Knowl's official VS Code Extension: your gateway to effortlessly access code documentation alongside functions. Empower your team to work more efficiently by automating code documents with our AI-driven documentation platform.
Languages Supported: JavaScript, TypeScript, Python, and Java. More coming soon!
Knowl Editor vs Github Copilot
Feature |
Knowl Editor |
GitHub Copilot |
Integration with Development Environments (IDE) |
✅ |
✅ |
Powered by Artificial Intelligence (AI) |
✅ |
✅ |
Guarantee of 100% Code Coverage Ensures complete reliability and thoroughness in code coverage. |
✅ |
❌ |
Support for Multiline Comments |
✅ |
❌ |
Automated Document Updates with Every Code Merge Keeps documentation consistently up-to-date with code changes. |
✅ |
❌ |
Rich Text Editing Within the IDE Allows for enhanced text formatting including support for Diagram, Table, API Endpoint and more directly in IDE. |
✅ |
❌ |
Detailed Context and Code Examples |
✅ |
❌ |
Consistent Language and Structural Integrity Ensures uniformity in presentation and language for better understanding. |
✅ |
❌ |
How to Use the Plugin
- Install Plugin
- Log using your company email_id
- Look out for the Knowl's “owl icon” next to each function.
- Click on "Generate Document" if you don't have any code documents in Knowl yet
- A quick hover shows the auto-generated docs, and a click gives you more details.
VS Code Screenshot
How to Generate Docs for Internal Repository
GitHub Action
- Create a new GitHub action '.yml' file and copy-paste the following code:
name: Knowl AI Code Documents
run-name: generate code docs
on:
push:
branches:
- 'main'
workflow_dispatch:
jobs:
gen-ai-doc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Generate AI docs
uses: knowl-doc/knowl-ai-code-docs@main
env:
KNOWL_API_KEY: ${{secrets.KNOWL_API_KEY}}
OPENAI_API_KEY: ${{secrets.OPENAI_API_KEY}}
OPENAI_BATCH_SIZE: 40
- Add the
KNOWL_API_KEY
in actions secrets.
- Generate and copy the Knowl API Key by navigating to your profile section in the Knowl
- Reach out to support@knowl.io if you want to create a profile and workspace for your team. We are still in the invite only phase.
- Add the
OPENAI_API_KEY
in secrets.
- Run the action manually.
See more details of the Action in the the Github Markeplace
Bitbucket Pipelines
- Add the following code to your
bitbucket-pipelines.yml
file:
pipelines:
branches:
main:
- step:
name: Update-knowl-docs
script:
- echo "Update Knowl Docs"
- pipe: docker://public.ecr.aws/t7d0n7r6/code-to-doc-bitbucket:latest
variables:
KNOWL_API_KEY: $KNOWL_API_KEY
OPENAI_API_KEY: $OPENAI_API_KEY
custom:
generate-knowl-docs:
- step:
name: Generate-knowl-docs
script:
- echo "Generate Knowl Docs"
- pipe: docker://public.ecr.aws/t7d0n7r6/code-to-doc-bitbucket:latest
variables:
KNOWL_API_KEY: $KNOWL_API_KEY
OPENAI_API_KEY: $OPENAI_API_KEY
- Run the pipeline manually.
- Don't forget to switch to the appropriate branch name prior to running the pipeline.
And that's it! You've now successfully set up your pipeline to generate documents for the repository.
Enjoy Coding and Leave the Documentation to Knowl!