Skip to content

Commit 1b93b94

Browse files
committed
docs: update VitePress config and add model config reference
- Update VitePress config to use environment variable for website ID - Add reference to model configuration guide in quick-start documentation - Correct URL in model configuration documentation These changes improve the clarity and accuracy of the documentation, ensuring that users can properly configure the website and understand how to set up models.
1 parent 5612f60 commit 1b93b94

File tree

6 files changed

+33
-3
lines changed

6 files changed

+33
-3
lines changed

docs/faq.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ GCOP integrates with your existing Git workflow and uses advanced language model
1313
### Is GCOP free to use?
1414

1515
GCOP is an open-source project and is free to use. However, some advanced features may require access to paid language model APIs.
16+
17+
### How to config my model?
18+
19+
Please refer to [How to Config Model](./how-to-config-model.md)

docs/guide/quick-start.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,34 @@ Before you begin, ensure you have the following:
7171
git c
7272
```
7373

74-
3. Choose the most appropriate message using arrow keys and press Enter.
74+
> Some times, if you use `git add .` and `git c` together, you can use `git ac` as a shortcut.
75+
76+
3. You can accept the default message, retry, retry by your feedback or exit after the AI generates the commit message.
77+
78+
Finally, you can see the commit message like this:
79+
80+
![commit message](../images/git-commit-2.png)
81+
82+
```bash
83+
(gcop) D:\Projects\gcop\docs>git ac
84+
[Code diff]
85+
...
86+
87+
88+
[Thought] The changes involve updating the VitePress configuration to use an environment variable for the website ID, adding a reference to a new documentation page in the quick-start guide, and correcting a URL in the model configuration documentation. These changes are primarily
89+
related to documentation and configuration updates.
90+
[Generated commit message]
91+
docs: update VitePress config and add model config reference
92+
93+
- Update VitePress config to use environment variable for website ID
94+
- Add reference to model configuration guide in quick-start documentation
95+
- Correct URL in model configuration documentation
96+
97+
These changes improve the clarity and accuracy of the documentation, ensuring that users can properly configure the website and understand how to set up models.
98+
? Do you want to commit the changes with this message? yes
99+
[main 5612f60] docs: update VitePress config and add model config reference
100+
3 files changed, 5 insertions(+), 2 deletions(-)
101+
```
75102

76103
### Other Useful Commands
77104

docs/images/git-commit-2.png

62.3 KB
Loading

docs/images/git-commit.png

342 KB
Loading

gcop/__main__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,6 @@ def commit_command(feedback: Optional[str] = None):
255255
).ask()
256256

257257
if response == "yes":
258-
console.print(f"[green]Committing with message: {commit_messages}[/]")
259258
subprocess.run(["git", "commit", "-m", commit_messages])
260259
elif response == "retry":
261260
commit_command(feedback=None)

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ requires = ["poetry-core"]
55

66
[tool.poetry]
77
name = "gcop"
8-
version = "1.3.1"
8+
version = "1.3.2"
99
description = "gcop is your git AI copilot."
1010
readme = "README.md"
1111
authors = ["gcop <zeeland4work@gmail.com>"]

0 commit comments

Comments
 (0)