Refresh documentation architecture + content strategy

[jmduke]

Content

• Getting started
  • Registration and setup
  • Importing
  • Building your base
  • Getting a custom domain
  • Hosting
  • Sending
  • Sending your first email
  • Scheduling an email
  • Markdown
  • Share images
  • Billing
• Advanced features
  • CSS
  • Tags
  • Metadata
  • RSS-to-email
  • Surveys
  • Paid subs
  • Multiple newsletters
  • Automations
  • Teams
  • Dedicated IP
  • Comments
• Tutorials
  • Automations sequences
  • Collecting names
  • Customizing list views
  • Drafting emails via the API
  • Scheduling emails via the API
• Dreamhost
• Migration guides
  • AWeber
  • Benchmark
  • Campaign Monitor
  • CC
  • ConvertKit
  • EmailOctopus
  • FeedBlitz
  • Mailchimp
  • Mailcoach
  • Mailerlite
  • Moosend
  • Revue
  • Substack
  • Tinyletter
• API
  • Emails
  • Subscribers
  • Changelog
  • Tags
  • Images
  • Newsletters
  • Exports
  • Bulk actions
  • Automations
  • Comments
• Integrations
  • Blogger
  • Carrd
  • Discord
  • Duda
  • Fathom
  • Framer
  • Linktree
  • Plausible
  • Stripe
  • Wordpress
• Esoterica
• Kudos
• Affiliate
• Subscriber referrals
• Glossary
• Template variables
• Automations reference
• Privacy
• Data exports
• Offboarding
• Law enforcement
• Screen reader

Tasks

• Really implement search
• Add description metadata to pages
• Add sticky footer with copyright and social links
• Add analytics
• Lightbox
• Video support (e.g. /share-images)
• iFrame / loom support (e.g. /blogger)
• Add anchor support to enum lists, so we can e.g. link to /event-types#subscriber.created
• Add tracking information for searches
• Add code-highlighting to Markdoc
• Allow collapsing overlong code samples
• Add basic table component
• Add link to buttondown.email application
• Update TypeScript code example to use fetch (and name it "JavaScript")
• Automatically run npm run search-index
• Sentry instrumentation for measuring search times
• Loading state for search
• Dedupe "Introduction" in search
• Add anchors to h1/h2/etc tags
• Show a mini table of contents on the right
• Mobile-optimize

Inspo

• https://skiff.com/ui/facepile
• https://duffel.com/docs
• https://developers.attio.com/docs/using-webhooks
• https://resend.com/docs/knowledge-base/introduction

[jmduke]

• Better empty state / no results state in search — it should prompt folks to email us or file a ticket if they can't find what they're looking for

[smonette]

We may need a few replacement snippets for old-docs components:

• <MultiLanguageSnippet> Primarily in Tutorials.
• <Playground> Primarily in Tutorials
• <ConditionallyRender> Only on building-your-subscriber-base atm
• <Notice> Across many article types

[smonette]

• The "/using-markdown" page needs a way to display output examples.

Old docs screenshot

[jmduke]

• Add a link to Discussions, per Add a link to Discussions in the documentation discussions#29