Skip to content

Common Issues

Use this page to resolve the most common docs site problems quickly.

  • Check the route prefix.
  • Confirm the page path matches the sidebar config.
  • Make sure the page is inside the expected folder.

Search not finding pages

  • Confirm the pages are included in the site build.
  • Check that the page title and headings are clear.
  • Avoid hiding important content in images.

Images not loading

  • Place static files in docs/public.
  • Reference them with an absolute path like /logo.png.

Notes

  • Keep fixes short and practical.
  • Mention the quickest check first.
  • Use the same terminology as the rest of the docs site.

Markdown-first documentation for teams that update docs often.