-
Notifications
You must be signed in to change notification settings - Fork 727
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
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…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)
…d in the docs repo?)
…transfer to home comp)
…at and edit steps 2+
…luding parts, how to put them together, antenna info for edison
…you wait for gear"; preserve instruction to learn these things before installing openAPS by adding a (placeholder) 'reading list' section to the prep section
…pics previously in 'while you wait for gear'
…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.
…e easier to find; rename section, recommend reading when done with installation process
…dings. Remove now unused subdirectory index.rst files; shift any content in those to section overviews.
…ur-latin-i-e-vs-e-g/ Mnemonic: In Essence vs. Example (Great)
… serial connection is a way to monitor a rig regardless of internet connection
…rks potentially only allowing http(s)
…t more cleanly; include info about how to update your settings where people will hopefully see it
…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
…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
This looks pretty good to me, but unfortunately work has continued and there are now many conflicts. Would you mind squashing all your commits and rebasing on master to get the updates? |
Of course, will do! |
Sorry for the delay! Closing this and replacing with #1537 which starts from the up-to-date master branch. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a new OpenAPS user I spent a lot of time reading the docs, and found some of the organization confusing - e.g., classification of various reference material under "While You Wait For Gear," information split or duplicated across various setup and troubleshooting sections. Some very helpful information was hard to find on my own initially (e.g., how to actually use a profile after updating the pump) - people very graciously helped me (thanks!) but shouldn't have had to. It seems like the docs were clearly organized at one point, but have grown organically for some time to the point where that wasn't as evident to a newcomer, and were ready for a routine cleanup.
Here is a proposed reorganization; you can see it hosted at https://draft-openaps-reorg.readthedocs.io/ I have tried not to change anything substantive or remove any information in this PR, although I've added some minor clarifications in places. The main changes are:
Obviously happy to make (/remove) any changes as requested, and to handle merging in existing PRs if that would be helpful, as I think I touched basically every file and will have caused merge conflicts.