Skip to content
This repository has been archived by the owner on Jul 21, 2023. It is now read-only.

Improve README flow #232

Open
rossng opened this issue Mar 23, 2021 · 1 comment
Open

Improve README flow #232

rossng opened this issue Mar 23, 2021 · 1 comment
Labels
C-enhancement Category: new feature or request D-medium Difficulty: neither hard nor easy T-documentation Theme: documentation

Comments

@rossng
Copy link
Member

rossng commented Mar 23, 2021

Comments from Benjamin as part of #86

  • Overall flow...
    • Separating Pre-Requisites from Setup as separate "phases" seems
      unnecessarily heavy.
    • Most of the README files begin with a sort of "Table of Contents" that
      makes subroutine calls to various sections of the rest of the document.
      This requires quite a bit of remembering state on the part of readers
      (especially since the whole README file is itself generally a subroutine
      call from the main README) and contributes to a feeling of overwhelm.
      Moreover, there is not very much material in any of the files besides
      the sections describing what to do.
    • So my suggestion for overall flow would be to
      1. Coalesce the pre-requisites and setup sections of every document
        into a single list
      2. Inline all the subroutine calls within individual README documents
        -- i.e., make the whole document be a list of ## sections each
        describing a major step of installation.
      3. For the few sections that contain miscellaneous notes and useful
        information, rather than setup instructions, just mark them clearly
        as "Notes" so the reader knows to skip over them on a first pass.
  • Big tables at bottoms of files: Please let's just put the instructions
    for env variables directly in the .example files! There are many
    advantages to this:
    • documentation right next to where you need it
    • avoids a subroutine call to a different part of the README
    • no width restriction --> encouragement to document things more
      verbosely --> good
@rossng rossng added T-documentation Theme: documentation C-enhancement Category: new feature or request D-medium Difficulty: neither hard nor easy labels Mar 23, 2021
@rossng
Copy link
Member Author

rossng commented Mar 23, 2021

There's also a definite issue with the ordering of Auth0 relative to everything else. Need to figure out if there are circular deps between Auth0 setup and actions/frontend setup instructions.

@EdNutting EdNutting added Asana and removed Asana labels Jun 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
C-enhancement Category: new feature or request D-medium Difficulty: neither hard nor easy T-documentation Theme: documentation
Development

No branches or pull requests

2 participants