Docs to Evidence

[archiewood]

Description

Migrate Docs to Evidence

Current Status here: https://docs-evidence.netlify.app/

Outstanding Todos

• Add Netlify Deploy for docs and remove Vercel
• Re-Index Algolia search (post merge)
• Pinned version of Evidence rather than workspace link?
• Markdown tables format poorly
  • may need row stripes
  • code snippets and URLS are wrong font size
• replace docusaurus admonitions with <Alert> components
• HTML tables unstyled
• Style Request Invite buttons
• Use Evidence Details component for FAQ
• Remove or replace footnotes in environments page
• Put "All Components" in Grid
• Custom Favicons
• check SEO
• create redirects

Nits

• Spacing between paragraphs feels "wrong" - a bit of a wall of text - needs more space above headers?
• No syntax highlighting (as per Evidence)
• Padding above map too small so overlaps code snippet fence above
• Code in headers is formatted wrong
• Cmd-K icon is superfluous on mobile
• Lots of codeblocks spill content outside viewport in mobile. You can access with scroll but maybe we should wrap or create wrap icon

Checklist

• For UI or styling changes, I have added a screenshot or gif showing before & after
• I have added a changeset
• I have added to the docs where applicable
• I have added to the VS Code extension where applicable

[changeset-bot]

⚠️ No Changeset found

Latest commit: da3b887

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
docs	❌ Failed (Inspect)			Apr 12, 2024 4:41pm

[netlify]

✅ Deploy Preview for evidence-development-workspace ready!

Name	Link
🔨 Latest commit	da3b887
🔍 Latest deploy log	https://app.netlify.com/sites/evidence-development-workspace/deploys/661964454ab8ec0009ca41e2
😎 Deploy Preview	https://deploy-preview-1808--evidence-development-workspace.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[hughess]

This is looking great. Just went through it and these were the only things I noticed (some of which are already in your list):

• Getting a query error on dimension grid page
• Code block syntax highlighting would help a lot
• Tabs page image looks a bit confusing - initially thought it was a query
• Spacing / visual hierarchy seems off in some places. No immediate fix needed, just flagging it