Documentation logo

Troubleshooting

Fix common docs site issues like build failures, 404 errors, and broken styles by checking your docs.json config, file paths, and dev cache.

Common issues and where to look when something in your docs site doesn't behave the way you expect.

Build won't start

If jamdesk dev exits immediately, check that docs.json is valid and that every page listed in the navigation actually exists on disk.

It helps to revisit how file organization maps file paths to URLs, then walk through previewing locally with the CLI one more time from the top.

Page not found

A 404 in the browser almost always means the path in docs.json doesn't match the file on disk. Double-check the casing and the folder structure — paths are case-sensitive.

For older projects, the legacy configuration guide covers environment-specific overrides.

Styles look wrong

Clear the dev cache with jamdesk dev --clean if a theme or color change in docs.json isn't showing up after a refresh.