Add an operations guide for upgrading/downgrading/resetting the OS#511
Merged
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR adds a new page to the documentation's Operation section for how to reset or upgrade/downgrade an SD card's installation of the PlanktoScope OS. This is intended to address an issue @tpollina had pointed out in the 2024-12-19 software meeting, that it's hard to find anything in the Operation section of the documentation related to flashing the SD card, even though that task is needed for routine operations after initial setup.
This PR also moves the docs's FAQ page out from the "Home" section of the docs, so that "Home" is a single page; this is intended to make the docs site show the top-level nav menu on mobile browsers on the Home page, instead of having the nav menu show a sub-menu for the Home page with a FAQ page under it.
This PR also updates/refreshes some out-of-date information on the OS architecture reference page (in the software technical reference section of the docs) about Forklift, potentially recording (and/or responding to? idk) some subset of the general shape of some very valid concerns which I believe @sonnyp had mentioned (after a review of that page of reference documentation) to @tpollina about technical/project/complexity/scope risks of using Forklift in the PlanktoScope OS. A brief summary of those concerns was mentioned in the 2024-12-19 software meeting; I had interpreted/summarized that summary in my note-taking as follows: "Sonny was pointing to Forklift as a potential red flag for “innovation tokens” for the PlanktoScope", but I would appreciate any corrections/clarifications.
This PR also makes minor improvements to the wording of various pieces of text added by #510 .