Skip to content

Commit 842ccca

Browse files
committed
docs(readme): fix readme error handling subsection
The commit removes detailed error handling subsections from the README.md to simplify documentation organisation. The removed sections included: - Git related errors - API key related errors - Anthropic API errors - Other errors All error handling information remains available in the main Error Handling section.
1 parent 553d886 commit 842ccca

File tree

1 file changed

+0
-33
lines changed

1 file changed

+0
-33
lines changed

README.md

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,6 @@ The generated commit messages are compatible with [googleapis/release-please](ht
2626
- [`diffCommit.maxTokens`](#diffcommitmaxtokens)
2727
- [`diffCommit.temperature`](#diffcommittemperature)
2828
- [Error Handling](#error-handling)
29-
- [Git Related](#git-related)
30-
- [API Key Related](#api-key-related)
31-
- [Anthropic API Errors](#anthropic-api-errors)
32-
- [Other Errors](#other-errors)
3329
- [Local Development](#local-development)
3430
- [Local Testing](#local-testing)
3531
- [Contributing](#contributing)
@@ -176,35 +172,6 @@ Diff Commit accommodates error handling to provide clear feedback and assist in
176172

177173
If you encounter any of these errors, Diff Commit will display a message with more details. For persistent issues, please check your configuration and if appropriate, raise an issue on [GitHub](https://github.com/tsdevau/diff-commit/issues).
178174

179-
### Git Related
180-
181-
- Git extension not found in VSCode
182-
- No Git repository found in the current workspace
183-
- No workspace folder found
184-
- No staged changes detected
185-
186-
### API Key Related
187-
188-
- API key is missing or not provided
189-
- Invalid API key format (should start with sk-ant-api)
190-
- Failed to access or update secure storage
191-
192-
### Anthropic API Errors
193-
194-
- **400** - Bad Request: Review your prompt and try again
195-
- **401** - Unauthorized: Invalid API key, update your API key and try again
196-
- **403** - Forbidden: Permission denied, update your API key and try again
197-
- **429** - Rate Limited: Too many requests, try again later
198-
- **500** - Server Error: Anthropic API server error
199-
200-
### Other Errors
201-
202-
- Failed to write commit message to Source Control
203-
- Failed to open commit message preview
204-
- No commit message was generated by the API
205-
206-
If you encounter any of these errors, the extension will display a message with more details. For persistent issues, please check your setup and if appropriate, raise an issue on [GitHub](https://github.com/tsdevau/diff-commit/issues).
207-
208175
## Local Development
209176

210177
1. Clone the [repository](https://github.com/tsdevau/diff-commit)

0 commit comments

Comments
 (0)