Create troubleshooting doc, add pre-release to changelog

Author: MeanderingProgrammer

Diff for: CHANGELOG.md

@@ -1,5 +1,25 @@
 # Change Log
 
+## Pre-release
+
+### Features
+
+- Make default icons consistent: [#37](https://github.com/MeanderingProgrammer/markdown.nvim/pull/37)
+  [7cfe1cf](https://github.com/MeanderingProgrammer/markdown.nvim/commit/7cfe1cfa3b77f6be955f10f0310d5148edc69688)
+- Document known limitations: [#34](https://github.com/MeanderingProgrammer/markdown.nvim/issues/34)
+  [#35](https://github.com/MeanderingProgrammer/markdown.nvim/issues/35)
+  [0adb35c](https://github.com/MeanderingProgrammer/markdown.nvim/commit/0adb35cc190d682d689a1a8415d5980c92708403)
+
+### Bug Fixes
+
+- Get mode at time of event instead of callback execution: [#36](https://github.com/MeanderingProgrammer/markdown.nvim/issues/36)
+  [b556210](https://github.com/MeanderingProgrammer/markdown.nvim/commit/b556210e6c8759b7d23d5bc74c84aaafe2304da4)
+- Update healthcheck to work with neovim 0.9.5: [64969bc](https://github.com/MeanderingProgrammer/markdown.nvim/commit/64969bc94a9d633dc23b59a382cab407c99fecb1)
+
+### Contributor Shoutouts
+
+- @AThePeanut4
+
 ## 3.1.0 (2024-06-05)
 
 ### Features

Diff for: TROUBLESHOOTING.md

@@ -0,0 +1,83 @@
+# Troubleshooting
+
+The following guide goes from easy to complex operations that can help when this
+plugin is not functioning how you expect. As such it is recommended to go in order.
+
+## Run healthcheck
+
+```vim
+:checkhealth render-markdown
+```
+
+If there are any `errors` these should be looked at closely, `warnings` can largely
+be ignored. They are generated to help debug issues for less critical components,
+i.e. `LaTeX` support.
+
+## Validate `filetype`
+
+This plugin only operates on `markdown` files by default, but can be expanded to
+run on any filetype with `markdown` injected by providing it in the config:
+
+```lua
+require('render-markdown').setup({
+    file_types = { 'markdown', <other_filetype> },
+})
+```
+
+Once you confirm the list of `filetypes` you expect this plugin to work on get
+the `filetype` of the current buffer and make sure it is in that list:
+
+```vim
+:lua vim.print(vim.bo.filetype)
+```
+
+## Provide debug logs
+
+If all else fails hopefully the logs can provide some insight. This plugin
+ships with logging, however it only includes errors by default.
+
+To help debug your issue you'll need to go through the following steps:
+
+1. Update the log level to `debug`
+2. Create a test file
+3. Generate logs from the test file
+4. Provide the logs in the issue
+
+### Update the log level to `debug`
+
+Change the plugin configuration to:
+
+```lua
+require('render-markdown').setup({
+    log_level = 'debug',
+})
+```
+
+### Create a test file
+
+Create a new `markdown` file locally with the following content:
+
+```text
+# Heading
+
+- Item
+  - Nested
+
+> [!NOTE]
+> A note
+
+- [ ] Unchecked
+- [x] Checked
+```
+
+### Generate logs from the test file
+
+To do this restart Neovim and open the `markdown` file from the previous step.
+
+This should trigger the render function by default, then close Neovim.
+
+### Provide the logs in the issue
+
+Logs are written to a file typically located at: `~/.local/state/nvim/render-markdown.log`.
+
+Copy the contents of that file and paste it into the issue.