Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit b334a0c

Browse files
committed
Add a Troubleshooting section to the README
1 parent 4ec92a5 commit b334a0c

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,27 @@ Here's an excerpt of the graph generated for Alamofire:
235235

236236
![Excerpt of swift-doc-api Diagram for Alamofire](https://user-images.githubusercontent.com/7659/73189318-0db0e880-40d9-11ea-8895-341a75ce873c.png)
237237

238+
## Troubleshooting
239+
240+
Having trouble with SwiftDoc? Have a look at this section for help.
241+
242+
### Homebrew: Failed to download resource "swift-doc"
243+
244+
If using Homebrew to install or upgrade SwiftDoc fails with a `404` error similar to this:
245+
246+
```bash
247+
curl: (22) The requested URL returned error: 404
248+
Error: Failed to download resource "swift-doc"
249+
```
250+
251+
Try untapping and reinstalling SwiftDoc:
252+
253+
```bash
254+
$ brew uninstall swift-doc
255+
$ brew untap swiftdocorg/formulae
256+
$ brew install swiftdocorg/formulae/swift-doc
257+
```
258+
238259
## GitHub Action
239260

240261
This repository also hosts a [GitHub Action][github actions]

0 commit comments

Comments
 (0)