Create doc from Pull Request with AI
You can create a document from a pull request. This is especially useful when a pull request tells a coherent "story" - for example, when it shows the addition of a new feature.
Steps to create a document from a pull request with AI
1) On a repository's page, click Create
, and you will see options to create a document.
![](https://cdn.statically.io/img/docs.swimm.io/img/web/web-click-create-bg.png)
2) Select PR to doc
to create a document from a pull request.
![](https://cdn.statically.io/img/docs.swimm.io/img/ai/pr-to-doc-step1-create-bg.png)
3) Choose the relevant pull request.
Options | Description |
---|---|
Just add to doc | Only add snippets and add your own context about the code changes. |
Create with AI | Swimm's AI will generate the context for your draft with code changes. (Optional) Add an outline or instructions for the document. |
![](https://cdn.statically.io/img/docs.swimm.io/img/ai/pr-to-doc-step2-modal-bg.png)
4) Click Create with AI
- This option will use Swimm's AI capabilities to generate a detailed document right from your pull request.
5) Review the document and modify your drafted document to include everything you want to cover.
- Need to re-run the document created from the pull request?
- Click on the
Revert and edit prompt
button.
- Click on the
![](https://cdn.statically.io/img/docs.swimm.io/img/ai/ai-revert-and-edit-prompt-bg.png)
6) Once your document is final, commit it to your repository.
![](https://cdn.statically.io/img/docs.swimm.io/img/getting-started-guide/commit-modal-web-bg.png)
Need help?
Head over to the /ask Swimm FAQ section or security page to learn more about our Azure OpenAI Integration.
This document is automatically kept up to date using Swimm.