How do I report bugs?

Bugs should be reported using the messaging widget available from your dashboard or by sending an email to support@gitbook.com. In order to get the best help possible, please provide as much context on how you encountered the bug.

Generate Network Captures for Troubleshooting

HAR and Console Log

A HAR file (HTTP Archive) captures the requests and responses exchanged between your browser and the GitBook application. A console log records browser messages, errors, and warnings, aiding in diagnosing issues with a website or application. Including these files with your support request will help us identify issues.

Chrome

  1. In Chrome, go to the page within GitBook where you are experiencing trouble.

  2. Navigate to the page where the issue occurs.

  3. Open Developer Tools via "View" → "Developer" or by right-clicking and selecting "Inspect"

  4. Go to the Network tab.

  5. Enable Preserve log to record all requests.

  6. Stop recording by clicking the red (🔴) button.

  7. Clear logs with the stop (🚫) button for a fresh start.

  8. Start recording again by clicking the record button.

  9. Reproduce the issue to capture the HAR.

  10. Click the ⬇ "Export HAR" button to save the file.

  11. Next Select the console tab

  12. Right-click anywhere in the console and select save as....

  13. Name the log file Chrome-console.log.

  14. Send both files as shared links in a reply to your case.

Firefox

  1. In Firefox, go to the page within GitBook where you are experiencing trouble.

  2. Click the Firefox menu (Three horizontal parallel lines) at the top-right of your browser window.

  3. Select web developer > network.

  4. The developer tools window opens as a docked panel at the side or bottom of Firefox.

  5. Click the network tab.

  6. Select persist logs.

  7. Refresh the page and reproduce the problem while the capture is running.

  8. After you successfully reproduce the issue, right-click any row of the activity pane and select Save all as HAR.

  9. Select the console tab.

  10. Right-click any row and select select all.

  11. Paste the content in a text file and name it console-log.txt.

  12. Send both files as shared links in a reply to your case.

Safari

  1. In Safari, go to the page within GitBook where you are experiencing trouble.

  2. In the menu bar at the top, click develop and select show web inspector.

  3. Click the console tab and select preserve log.

  4. Go back to the network tab.

  5. Refresh the page and reproduce the problem while the capture is running.

  6. After you successfully reproduce the issue, right-click any row of the activity pane and select export HAR.

  7. Click the console tab.

  8. Right-click any row and select select all.

  9. Paste the content in a text file and name it console-log.txt.

  10. Send both files as shared links in a reply to your case.

Internet Explorer (IE11)

  1. In Internet Explorer, go to the page within GitBook where you are experiencing trouble.

  2. Click the gear icon in the top right.

  3. Select F12 developer tools.

  4. Click the network tab.

  5. Clear the clear entries on navigate option, which is selected by default. The icon looks like blue arrow with a red X.

  6. The green play button (start profiling session), should be selected by default. This means the capture function is running.

  7. Refresh the the page and reproduce the problem while the capture is running.

  8. Once you have reproduced the issue, click the export as HAR icon. The icon looks like a floppy disk.

  9. Click the console tab.

  10. Right-click any row and select copy all.

  11. Paste the content in a text file and name it console-log.txt.

  12. Send both files as shared links in a reply to your case.

Edge

  1. In Edge, go to the page within GitBook where you are experiencing trouble.

  2. At the top-right of your browser window, click the Edge menu (⋮)

  3. Select developer tools.

  4. Click the network tab.

  5. Clear the clear entries on navigate option, which is selected by default. The icon looks like blue arrow with a red X.

  6. The green play button (start profiling session), should be selected by default. This means the capture function is running.

  7. Refresh the the page and reproduce the problem while the capture is running.

  8. Once you have reproduced the issue, click the export as HAR icon. The icon looks like a floppy disk.

  9. Click the console tab.

  10. Right-click any row and select copy all.

  11. Paste the content in a text file and name it console-log.txt.

  12. Send both files as shared links in a reply to your case.

Last updated