Skip to content

Instantly share code, notes, and snippets.

@rjmackay
Created July 10, 2015 02:19
Show Gist options
  • Save rjmackay/bfa36d7cd47a2e207292 to your computer and use it in GitHub Desktop.
Save rjmackay/bfa36d7cd47a2e207292 to your computer and use it in GitHub Desktop.
Feedback on docs while flying
layout title weight
page
Feedback
0

Feedback on docs so far

  • I dislike targetting the docs around v2 users.. we need that but could we just have a 'V3 for V2 users' section?

Intro

  • Mostly good.
  • Wanders into developer centric stuff towards the end. Skip that?

Designing a new approach

  • Who is this written for? it doesn't seem useful to deployers.
    • Does it really make sense to tell a story about code/development?
  • Extract some key points for architecture backgrounder in dev guide
  • Much of this i sjust not true. Edit.

Building

  • This is probably some of the most useful content for the user guide.
  • Needs editing: its a wall of text right now.
  • Including examples would make this much easier to follow
  • Probably split this out into sections.

Install

We need to rethink this..

  1. its a common element between user, and developer guides. And its most likely to change over time. Maybe split it out of the guide entirely?

Sections like:

  1. Getting started / Install
  2. User guide
  3. Developer guide

Config

  • The intro ref to v2 differences could do with a quick bullet list of differences, and links to further info.
  • Base url explanation makes zero sense..
  • Seems super bare bones.. Need to build this out into sub sections.

Data

  • Wall of text. Desperately needs breaking up

Deploying

  • A lot of this needs to link back to the building chapter..
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment