Website

[jasonkuhrt]

We would like a website

Why

• introducing the tool
• offering docs
  • guide organized by topic/domain
  • api reference documentation
  • recipes (problem-solution)
  • principals and architecture
  • compare & contrast
• community hub
• hosting a blog
• brand (aka: giving confidence to user base that we're invested)

References / Anti-References (tbd)

https://relay.dev/en/

• intro / api / guide / principals

https://vuejs.org/

• guide / api / style / examples / cookbook / video

https://reactjs.org/

• home page code examples
• home page linked tutorial
• api / testing / hooks / concepts / faq / ...

https://www.keystonejs.com/

• api / guide / quick start / packages
• super fast loading docs

https://hasura.io/

• heavy marketing
• bad doc experience (compare to keystone, for example)

https://www.apollographql.com/

• heavy marketing
• home page linked tutorial
• slow loading docs (!)

Content

Formally Tracked

• Website section with API reference for app #230
• Website section for recipes #228
• Website section for comparison to other tools #227
• Website section for base guides #229
• website guide for databases #236
• Website guide for authentication #237
• Website guide for authorization #238
• Website guide for testing #239
• Architecture diagram #314

Other Ideas

Community Hub

• currently pinned github issues
• core team
• contributors
• release history
• slack link
• current sprint
  • goal
  • issues
  • ends on

Branding

• minimal
• focus on great great great typography typography typography typography ...
• dark [theme]
• understated before overstated tone
• no hype, that's the users' job (if we do ours)
• no putdowns of others' work
• community oriented (not mount olympus)

[jasonkuhrt]

Removing blog idea from this epic

- _blog_

- - post per stable release
- - case-studies
- - ...

[jasonkuhrt]

Clean example of docs https://gcanti.github.io/fp-ts/.