Skip to content

feat: reinstate instant loading#745

Merged
Valastiri merged 3 commits intoprimaryfrom
instant-nav
Mar 9, 2023
Merged

feat: reinstate instant loading#745
Valastiri merged 3 commits intoprimaryfrom
instant-nav

Conversation

@Valastiri
Copy link
Copy Markdown
Member

@Valastiri Valastiri commented Feb 19, 2023

Summary

Uncomments the navigation.instant feature in our config to enable instant loading across the site potentially saving bandwidth with the size of our documentation.

Original Issue

An inherent problem from before is that anchor links to sections clicked on from Discord do not take you to the relevant section on page.

Benefit

The largest benefit is stated from the mkdocs-material documentation:

The resulting page is parsed and injected and all event handlers and components are rebound automatically, i.e., Material for MkDocs now behaves like a Single Page Application. Now, the search index survives navigation, which is especially useful for large documentation sites.

Testing

Requires some testing to see if the original Issue persists but probably the small issue would be outweighed by the performance benefits.

See Discord comment in docs channel link here for the links for testing.

If reporting testing please provide the following:

Device Type + OS: iPhone iOS 16
Browser Used: Chrome / Safari
Arrived at Section on Page: Yes/No

Location

  • mkdocs.yml

Discord username (if different from GitHub): Valastiri#8902

@vercel
Copy link
Copy Markdown

vercel Bot commented Feb 19, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
docs ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Mar 8, 2023 at 10:55PM (UTC)

@github-actions github-actions Bot added the repo Changes to Repo or Config label Feb 19, 2023
@alepouna
Copy link
Copy Markdown
Member

Device: Android 13 TP1A - MIUI Global 14.0.1 (Xiaomi Mi 11 Pro)
Browsers:

  • Edge 110.0.1587.41 -
  • Chrome 110.0.5481.65 -
  • Brave 1.48.164 with Chromium 110.0.5481.100

engine-start-taxi/#afsflight-instruments Yes
qa-process/#tier-1 Yes
fbw-versions/#experimental-version No on first try with edge, new tab does. Weird, could be random case of Edge bark. Yes on everything else.

@Valastiri
Copy link
Copy Markdown
Member Author

updated version 9.1.1 of mkdocs solve this issue (tested with @frankkopp on discord + myself)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

repo Changes to Repo or Config

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants