Overview

Right now we have some performance issues when exporting the documentation to static pages. This issue is related to all performance and upgrades issues for the docs.

Upgrade Next 10

• Basic Next upgrade → [docs] Upgrade docs to Next 9.5 #10151
• Fix new Next 9 fast refresh warnings → [docs] Replace anonymous components with named components #10172
• Upgrade to Next 10 → [docs] upgrade to Next.js 10 and use Webpack 5 #12354

Clean up Next legacy workarounds

• Remove custom server.js to use built-in features → [docs] Remove custom server and add CORS headers to Next #10182
• Remove @zeit/next-css plugin to rely on built-in support → [docs] Remove legacy Next css plugin to use built-in support #10181
• Upgrade Emotion to v10 → [docs] Upgrade Emotion to v10 #10256

Performance issues

• Find the cause of extreme amount of fs.statSync calls
• Find the cause of extreme babel traverse usage

UX improvements

• Implement per-page-customizable table of contents on all pages → [docs] Right sidebar with Table of Contents #10230
• Unify API reference page heading structures (e.g. API, Methods, Constants, etc)
• Sort the version selector from cutting edge to oldest → [docs] Fix version selector order from cutting edge to oldest #10259
• ? SDK version on versioned pages isn't obvious when scrolling down
• ? Add explicit version of packages to the docs (e.g. x.x.x tag next to title or expo install [email protected])
• ? Add examples for both TypeScript and JavaScript with tabbar-toggle
• ? Add tags in headers for methods only available on certain platforms
• ? Add style-guideline for props lists like these

DX improvements

• Move codebase over to TypeScript → [docs] Migrate codebase to TypeScript #10324
• Replace custom MDX loader with wrapper from MDX Provider
• Simplify Github slugger implementation (e.g. with remark-slug or rehype-slug)
• Use MDX tooling to validate broken links
• Add eslint-config-universe → [docs] Migrate codebase to TypeScript #10324
• Add ESLint to CI → [docs] Add lint to CI #10445
• Break up next.config.js into smaller understandable chunks (e.g. withPreval, withMdx)

Other improvements

• Scope the usage of Preval to prevent usage messing up the cache → [docs] Limit preval usage and simplify caching #10174
• Only store the cache in CI to prevent exports with different build ids → [docs] Limit preval usage and simplify caching #10174
• Upgrade to MDX v1 → [docs] Upgrade MDX loader to v1 #10177
• Replace the versions/latest copy with symlink to avoid duplicate pages being built
• Upgrade docs workflow to Node 14 → [docs] Upgrade docs workflow to Node 14 #10175
• Improve crawler methods to index the docs website → [docs] Add sitemap to avoid page-link issues with crawlers #10194

Long term stuff

• Start preparing for MDX v2 support
• Help Next.js solve the trailingSlash and status page issue → comment
• Add account context to inline docs (e.g. account name, projects, orgs)
• Add forum context to show topics related to modules (see discussion)