Docs Revamp > Update to VitePress (Full Text Search)

[0xpatrickdev]

What is the Problem Being Solved?

VuePress is in maintenance mode, and lacks features of a more modern documentation site (e.g., search). Update to VitePress, the successor to VuePress, maintaining existing functionality.

Description of the Design

• Preserve existing .md files and navigation
• Preserve existing URLs and URL redirects
• Preserve existing broken link check logic (CI)
• Integrate new Search plugin (minisearch)
• Preserve existing testing framework (ava + zoe contract snippets)

Security Considerations

Scaling Considerations

• (minisearch) is client side and seems to add ~400kB to the downloaded assets
• sidebar (side nav) links are not autogenerated and require authors to maintain links. Consider using one of the sidebar plugins once there's greater alignment on navigation.

Test Plan

Upgrade Considerations