Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganization/cleanup of docs #1494

Closed
wants to merge 54 commits into from

Commits on Aug 9, 2019

  1. Configuration menu
    Copy the full SHA
    723009f View commit details
    Browse the repository at this point in the history
  2. update requirements.txt

    Kim Scott committed Aug 9, 2019
    Configuration menu
    Copy the full SHA
    7c56bbb View commit details
    Browse the repository at this point in the history
  3. ignore built html

    Kim Scott committed Aug 9, 2019
    Configuration menu
    Copy the full SHA
    b6d251f View commit details
    Browse the repository at this point in the history
  4. use subdirectory index.rst files to create main toctree for maintaina…

    …bility (tradeoff: sidebar toctree isn't kept always 'expanded' via explicit listing of contents, but allows straightforward "summary" text for main headings in the index file)
    Kim Scott committed Aug 9, 2019
    Configuration menu
    Copy the full SHA
    ca0c699 View commit details
    Browse the repository at this point in the history
  5. split up info about how to use documentation and where to connect wit…

    …h other users
    Kim Scott committed Aug 9, 2019
    Configuration menu
    Copy the full SHA
    ace7461 View commit details
    Browse the repository at this point in the history
  6. bumping decocare to get readthedocs build working (is this really use…

    …d in the docs repo?)
    Kim Scott committed Aug 9, 2019
    Configuration menu
    Copy the full SHA
    37be929 View commit details
    Browse the repository at this point in the history
  7. removing unused dependencies for docs

    Kim Scott committed Aug 9, 2019
    Configuration menu
    Copy the full SHA
    baa4f97 View commit details
    Browse the repository at this point in the history
  8. starting organization of install steps (just committing & pushing to …

    …transfer to home comp)
    Kim Scott committed Aug 9, 2019
    Configuration menu
    Copy the full SHA
    ec30c64 View commit details
    Browse the repository at this point in the history
  9. shift list of steps to overview

    Kim Scott committed Aug 9, 2019
    Configuration menu
    Copy the full SHA
    0fd598c View commit details
    Browse the repository at this point in the history
  10. fix 'common error messages' section

    Kim Scott committed Aug 9, 2019
    Configuration menu
    Copy the full SHA
    0682b9a View commit details
    Browse the repository at this point in the history

Commits on Aug 14, 2019

  1. Configuration menu
    Copy the full SHA
    cabb498 View commit details
    Browse the repository at this point in the history
  2. fix paths to images in flashing instructions

    Kim Scott committed Aug 14, 2019
    Configuration menu
    Copy the full SHA
    20b2843 View commit details
    Browse the repository at this point in the history
  3. continue consolidating flashing instructions

    Kim Scott committed Aug 14, 2019
    Configuration menu
    Copy the full SHA
    439bc86 View commit details
    Browse the repository at this point in the history

Commits on Aug 15, 2019

  1. rough consolidation of all flashing instructions - still need to form…

    …at and edit steps 2+
    Kim Scott committed Aug 15, 2019
    Configuration menu
    Copy the full SHA
    3eb47fa View commit details
    Browse the repository at this point in the history

Commits on Aug 21, 2019

  1. consolidate logging-in-via-console instructions that were in several …

    …places
    Kim Scott committed Aug 21, 2019
    Configuration menu
    Copy the full SHA
    ee5cb88 View commit details
    Browse the repository at this point in the history

Commits on Aug 26, 2019

  1. minor changes, just syncing

    Kim Scott committed Aug 26, 2019
    Configuration menu
    Copy the full SHA
    4940e90 View commit details
    Browse the repository at this point in the history

Commits on Aug 27, 2019

  1. consolidate info about hardware into edison section & pi section, inc…

    …luding parts, how to put them together, antenna info for edison
    Kim Scott committed Aug 27, 2019
    Configuration menu
    Copy the full SHA
    cb833f3 View commit details
    Browse the repository at this point in the history

Commits on Aug 30, 2019

  1. get all links working

    Kim Scott committed Aug 30, 2019
    Configuration menu
    Copy the full SHA
    6491d1a View commit details
    Browse the repository at this point in the history
  2. organize by general topic instead of pushing information into "while …

    …you wait for gear"; preserve instruction to learn these things before installing openAPS by adding a (placeholder) 'reading list' section to the prep section
    Kim Scott committed Aug 30, 2019
    Configuration menu
    Copy the full SHA
    b2f923b View commit details
    Browse the repository at this point in the history
  3. avoid accidental extra section

    Kim Scott committed Aug 30, 2019
    Configuration menu
    Copy the full SHA
    eab9346 View commit details
    Browse the repository at this point in the history
  4. fix typo in conf.py

    Kim Scott committed Aug 30, 2019
    Configuration menu
    Copy the full SHA
    2adb54f View commit details
    Browse the repository at this point in the history
  5. and again

    Kim Scott committed Aug 30, 2019
    Configuration menu
    Copy the full SHA
    3d66824 View commit details
    Browse the repository at this point in the history

Commits on Aug 31, 2019

  1. Add a reading list to the prep section, corresponding to remaining to…

    …pics previously in 'while you wait for gear'
    Kim Scott committed Aug 31, 2019
    Configuration menu
    Copy the full SHA
    977308c View commit details
    Browse the repository at this point in the history

Commits on Sep 2, 2019

  1. editing overview section for clarity. This gets into more personal ta…

    …ste than some of the other organizational efforts; e.g., removing the overview-of-steps image because I found it substantially more confusing than helpful (even though it looks very snazzy) and replacing with a text-based overview indicating that hardware and other prep can be done in parallel, then you install, then you'll likely do some additional customization. Keeping these changes separate, & not changing any filenames, in case anyone wants to cherry-pick around this one.
    Kim Scott committed Sep 2, 2019
    Configuration menu
    Copy the full SHA
    2d90cd0 View commit details
    Browse the repository at this point in the history
  2. add missed link

    Kim Scott committed Sep 2, 2019
    Configuration menu
    Copy the full SHA
    b546f65 View commit details
    Browse the repository at this point in the history

Commits on Sep 3, 2019

  1. move a few "tips and tricks" to other appropriate locations so they'r…

    …e easier to find; rename section, recommend reading when done with installation process
    Kim Scott committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    e398ce5 View commit details
    Browse the repository at this point in the history
  2. typo

    Kim Scott committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    b9e41f7 View commit details
    Browse the repository at this point in the history
  3. consistent tense/capitalization

    Kim Scott committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    7b96537 View commit details
    Browse the repository at this point in the history

Commits on Sep 8, 2019

  1. reinstate the nice already-expanded-to-one-level ToC sidebar with hea…

    …dings. Remove now unused subdirectory index.rst files; shift any content in those to section overviews.
    Kim Scott committed Sep 8, 2019
    Configuration menu
    Copy the full SHA
    6b8f11c View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    a6aae9e View commit details
    Browse the repository at this point in the history
  3. list wifi files separately in main sidebar

    Kim Scott committed Sep 8, 2019
    Configuration menu
    Copy the full SHA
    300f581 View commit details
    Browse the repository at this point in the history
  4. a round of i.e. vs. e.g. - see https://www.grammarly.com/blog/know-yo…

    …ur-latin-i-e-vs-e-g/  Mnemonic: In Essence vs. Example (Great)
    Kim Scott committed Sep 8, 2019
    Configuration menu
    Copy the full SHA
    b68d545 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    e375eb0 View commit details
    Browse the repository at this point in the history
  6. minor organizational edits to monitoring, mostly just make clear that…

    … serial connection is a way to monitor a rig regardless of internet connection
    Kim Scott committed Sep 8, 2019
    Configuration menu
    Copy the full SHA
    377372d View commit details
    Browse the repository at this point in the history
  7. minor organization edits regarding wifi options, add note about netwo…

    …rks potentially only allowing http(s)
    Kim Scott committed Sep 8, 2019
    Configuration menu
    Copy the full SHA
    7e7656f View commit details
    Browse the repository at this point in the history
  8. more ie/eg

    Kim Scott committed Sep 8, 2019
    Configuration menu
    Copy the full SHA
    5820dca View commit details
    Browse the repository at this point in the history
  9. minor clarifications to autosens section; move one warning to oref1 s…

    …ection
    Kim Scott committed Sep 8, 2019
    Configuration menu
    Copy the full SHA
    ec20ef9 View commit details
    Browse the repository at this point in the history
  10. minor organization edits Nightscout section

    Kim Scott committed Sep 8, 2019
    Configuration menu
    Copy the full SHA
    5f6b1ec View commit details
    Browse the repository at this point in the history
  11. minor organizational changes to oref1 section

    Kim Scott committed Sep 8, 2019
    Configuration menu
    Copy the full SHA
    4f893f5 View commit details
    Browse the repository at this point in the history

Commits on Sep 9, 2019

  1. fix typo in index

    Kim Scott committed Sep 9, 2019
    Configuration menu
    Copy the full SHA
    acac894 View commit details
    Browse the repository at this point in the history
  2. separate "how to run autotune" from "how to understand autotune" a bi…

    …t more cleanly; include info about how to update your settings where people will hopefully see it
    Kim Scott committed Sep 9, 2019
    Configuration menu
    Copy the full SHA
    7a6d6e3 View commit details
    Browse the repository at this point in the history
  3. one more i.e. that snuck by, and italics I suspect don't improve read…

    …ability
    Kim Scott committed Sep 9, 2019
    Configuration menu
    Copy the full SHA
    98445c2 View commit details
    Browse the repository at this point in the history
  4. also reference linux guide in installation overview

    Kim Scott committed Sep 9, 2019
    Configuration menu
    Copy the full SHA
    a8c50be View commit details
    Browse the repository at this point in the history
  5. fix links thru hardware

    Kim Scott committed Sep 9, 2019
    Configuration menu
    Copy the full SHA
    69797e5 View commit details
    Browse the repository at this point in the history

Commits on Sep 11, 2019

  1. finish fixing links

    Kim Scott committed Sep 11, 2019
    Configuration menu
    Copy the full SHA
    00db9e0 View commit details
    Browse the repository at this point in the history
  2. make sure notes about autotune using a single ISF/CR are in the main …

    …prep section, not specifically for Medtronic pumps; include more detail about how that might affect automatic usage in the how it works section; consolidate several places linking to where to give feedback about Autotune
    Kim Scott committed Sep 11, 2019
    Configuration menu
    Copy the full SHA
    73f7be2 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    c2f6387 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    35495ad View commit details
    Browse the repository at this point in the history
  5. put info about how openaps/nightscout work together in main nightscou…

    …t setup page instead of troubleshooting; put all troubleshooting info in troubleshooting page instead of split between setup and troubleshooting; put info about additional pills not to trust in the setup page
    Kim Scott committed Sep 11, 2019
    Configuration menu
    Copy the full SHA
    f9c2972 View commit details
    Browse the repository at this point in the history
  6. empirically checking rtd url_resolver default sorry

    Kim Scott committed Sep 11, 2019
    Configuration menu
    Copy the full SHA
    41794f9 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    9ea76a6 View commit details
    Browse the repository at this point in the history
  8. remove extra whitespace

    Kim Scott committed Sep 11, 2019
    Configuration menu
    Copy the full SHA
    ac245a1 View commit details
    Browse the repository at this point in the history
  9. Configuration menu
    Copy the full SHA
    15520c4 View commit details
    Browse the repository at this point in the history

Commits on Sep 12, 2019

  1. move note about multiple CRs/ISFs out of pump-specific section to Aut…

    …otune
    Kim Scott committed Sep 12, 2019
    Configuration menu
    Copy the full SHA
    13b8c8e View commit details
    Browse the repository at this point in the history