Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix errors in README.md #83

Merged
merged 5 commits into from
Dec 5, 2024
Merged

docs: fix errors in README.md #83

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f663ed4
docs: fix the display of demonstration videos in README.md
rburmorrison Dec 5, 2024
7714555
docs: more demonstration video link fixes
rburmorrison Dec 5, 2024
c6bff1e
docs: update README.md to fix HTML syntax in details summaries
rburmorrison Dec 5, 2024
156a06b
docs: add bracket to example snippet with missing bracket
rburmorrison Dec 5, 2024
58781ff
docs: add extra horizontal rule between demonstration videos for cons…
rburmorrison Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 15 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,29 +40,29 @@ While this project is still under development, a substantial part of the code is

Seamlessly switch between providers and models.
<div align="left">
<img src="https://github.com/user-attachments/assets/0df0348f-85c0-4a2d-ba1f-ede2738c6d02" width="100%">
<p>https://github.com/user-attachments/assets/0df0348f-85c0-4a2d-ba1f-ede2738c6d02</p>
</div>

---

Trigger code completions based on comments.
<div align="left">
<img src="https://github.com/user-attachments/assets/197f99ac-9854-4fe9-bddb-394c1b64f6b6" width="100%">
<p>https://github.com/user-attachments/assets/197f99ac-9854-4fe9-bddb-394c1b64f6b6</p>
</div>

---

Let the parrot fix your bugs.
<div align="left">
<img src="https://github.com/user-attachments/assets/d3a0b261-a9dd-45e6-b508-dc5280594b06" width="100%">
<p>https://github.com/user-attachments/assets/d3a0b261-a9dd-45e6-b508-dc5280594b06</p>
</div>

---

<details>
<summary>Rewrite a visual selection with `PrtRewrite`.</summary>
<div align="left">
<img src="https://github.com/user-attachments/assets/c3d38702-7558-4e9e-96a3-c43312a543d0" width="100%">
<p>https://github.com/user-attachments/assets/c3d38702-7558-4e9e-96a3-c43312a543d0</p>
</div>
</details>

Expand All @@ -71,7 +71,7 @@ Let the parrot fix your bugs.
<details>
<summary>Append code with the visual selection as context with `PrtAppend`.</summary>
<div align="left">
<img src="https://github.com/user-attachments/assets/80af02fa-cd88-4023-8a55-f2d3c0a2f28e" width="100%">
<p>https://github.com/user-attachments/assets/80af02fa-cd88-4023-8a55-f2d3c0a2f28e</p>
</div>
</details>

Expand All @@ -80,14 +80,16 @@ Let the parrot fix your bugs.
<details>
<summary>Add comments to a function with `PrtPrepend`.</summary>
<div align="left">
<img src="https://github.com/user-attachments/assets/9a6bfe66-4bc7-4b63-8694-67bf9c23c064" width="100%">
<p>https://github.com/user-attachments/assets/9a6bfe66-4bc7-4b63-8694-67bf9c23c064</p>
</div>
</details>

---

<details>
<summary>Retry your latest rewrite, append or prepend with `PrtRetry`.</summary>
<div align="left">
<img src="https://github.com/user-attachments/assets/03442f34-687b-482e-b7f1-7812f70739cc" width="100%">
<p>https://github.com/user-attachments/assets/03442f34-687b-482e-b7f1-7812f70739cc</p>
</div>
</details>

Expand Down Expand Up @@ -363,23 +365,23 @@ to consider a visual selection within an API request.
#### Demonstrations

<details>
<summary>With `user_input_ui = "native"`, use `vim.ui.input` as slim input interface.</summary>
<summary>With <code>user_input_ui = "native"</code>, use <code>vim.ui.input</code> as slim input interface.</summary>
<div align="left">
<img src="https://github.com/user-attachments/assets/c2fe3bde-a35a-4f2a-957b-687e4f6f2e5c" width="100%">
<p>https://github.com/user-attachments/assets/c2fe3bde-a35a-4f2a-957b-687e4f6f2e5c</p>
</div>
</details>

<details>
<summary>With `user_input_ui = "buffer"`, your input is simply a buffer. All of the content is passed to the API when closed.</summary>
<summary>With <code>user_input_ui = "buffer"</code>, your input is simply a buffer. All of the content is passed to the API when closed.</summary>
<div align="left">
<img src="https://github.com/user-attachments/assets/63e6e1c4-a2ab-4c60-9b43-332e4b581360" width="100%">
<p>https://github.com/user-attachments/assets/63e6e1c4-a2ab-4c60-9b43-332e4b581360</p>
</div>
</details>

<details>
<summary>The spinner is a useful indicator for providers that take longer to respond.</summary>
<div align="left">
<img src="https://github.com/user-attachments/assets/ebcd27cb-da00-4150-a0f8-1d2e1afa0acb" width="100%">
<p>https://github.com/user-attachments/assets/ebcd27cb-da00-4150-a0f8-1d2e1afa0acb</p>
</div>
</details>

Expand Down Expand Up @@ -471,7 +473,7 @@ require("parrot").setup {
I have the following code from {{filename}}:

```{{filetype}}
{filecontent}}
{{filecontent}}
```

Please look at the following section specifically:
Expand Down
Loading