blitzjs.com icon indicating copy to clipboard operation
blitzjs.com copied to clipboard

Broken Links

Open MartinMuzatko opened this issue 3 years ago • 5 comments

Hi there!

I found a few broken links in the documentation. I think most of the missing .md pages just come from automated documentation. But removing .md alone does not seem to fix the problem.

https://blitzjs.com/docs/get-static-paths links to https://blitzjs.com/docs/routing/dynamic-routes.md https://blitzjs.com/docs/router links to https://blitzjs.com/docs/basic-features/data-fetching.md https://blitzjs.com/docs/router#router-object links to https://blitzjs.com/docs/advanced-features/preview-mode.md

https://blitzjs.com/docs/pages#persisting-layouts links to https://blitzjs.com/docs/layout https://blitzjs.com/docs/mutation-usage links to https://blitzjs.com/docs/resolver-utilities (see invalidateQuery()) https://blitzjs.com/docs/blitz-config#disable-keep-alive links to https://blitzjs.com/docs/basic-features/supported-browsers-features#polyfills

MartinMuzatko avatar Dec 13 '21 09:12 MartinMuzatko

Thanks for creating the issue!

beerose avatar Dec 13 '21 10:12 beerose

The persisting layouts link is the only one that appears to be broken at the moment, but I was wondering whether some of these are still valid based on the documentation.json file. Are files in /pages/docs valid if they're not in that file, or does that file need to be updated to account for files in the docs directory that may not be in the nav?

corydeppen avatar Oct 01 '22 17:10 corydeppen

@corydeppen, yeah, we removed a bunch of pages from our docs after moving to Blitz 2.0. They were redundant as it was mostly the same stuff as you can find in the official Next.js docs. Though, we didn't remove the markdown files from the repo (which is something we should do soon)

beerose avatar Oct 03 '22 03:10 beerose

There are some broken URI fragments in the "Notes" box in the session management, ie

  • https://blitzjs.com/docs/session-management#sessioncontext
  • https://blitzjs.com/docs/session-management#access-session-on-the-server

There are no correspoding elements on the page.

ricky0123 avatar Mar 16 '23 06:03 ricky0123

I would like to contribute to this ?

VedanthB avatar Mar 27 '23 20:03 VedanthB