> For the complete documentation index, see [llms.txt](https://docs.realmacsoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmacsoftware.com/classic/user-manual/troubleshooting/how-to-report-a-bug.md). # How to Report a Bug If you've found an issue, here's what to do Should you come across a bug in RapidWeaver there are a few things we need to help resolve the bug or issue you are seeing. All bug reports should be sent to so we can deal with them more swiftly. We'll contact you directly should we require any more information. {% hint style="info" %} **Helpful information when reporting a bug** Please try to send us as much information as you can about the bug, this will help us locate and fix it much quicker. * RapidWeaver version * macOS version * Steps to reproduce the bug (bonus points for an example project) * Screen recording (or screenshots) * Exact error message as it appears * Crash log {% endhint %} ### **How to record your screen** Use QuickTimePlayer.app, this can be found in your Applications Folder. To create a simple recording, **choose File › New Screen Recording** from the menu. Click the red record button, then follow the instructions on the screen. To save, choose **File › Export** and select the quality. Alternatively, you can use the keyboard shortcut [command-shift-5](/classic/user-manual/keyboard-shortcuts.md) to bring up the onscreen Screen Recording controls.
### How to find a crash log Whenever an application on macOS crashes, it’ll automatically create a .crash file containing details as to what may have caused the crash. In the rare event that RapidWeaver crashes, sending us a crash log will help us find out what caused the crash, and how we can fix it. How to find your crash Logs(s): * In the Finder, go to your Applications folder, then Utilities and launch Console.app * Under the User Diagnostic Reports portion of the sidebar, locate the most recent crash. * When found, Control-click it, and then select “Reveal in Finder” from the shortcut menu. * Copy, or drag out the selected file from the Finder window and attach it to an email and send it to --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.realmacsoftware.com/classic/user-manual/troubleshooting/how-to-report-a-bug.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.