librem5-user-docs-common issueshttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues2019-10-30T16:08:35Zhttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/1Add a section about the smart card in the Librem 5 user guide2019-10-30T16:08:35ZDavid BoddieAdd a section about the smart card in the Librem 5 user guideResolve the 2FF in other documents ([FAQ](https://puri.sm/faq/what-are-the-phone-specs/), [announcement](https://puri.sm/posts/librem-5-smartphone-final-specs-announced/), [shop](https://shop.puri.sm/shop/librem-5/)) vs. what's in the gu...Resolve the 2FF in other documents ([FAQ](https://puri.sm/faq/what-are-the-phone-specs/), [announcement](https://puri.sm/posts/librem-5-smartphone-final-specs-announced/), [shop](https://shop.puri.sm/shop/librem-5/)) vs. what's in the guide already.David BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/3Secure connection and reader mode in Web documentation2019-10-30T16:07:40ZDavid BoddieSecure connection and reader mode in Web documentationFrom Purism/docs.puri.sm!58, we should document the padlock and book icons in the address bar.From Purism/docs.puri.sm!58, we should document the padlock and book icons in the address bar.David BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/27Librem 5: System upgrade is undocumented2020-12-07T10:53:48ZJonas Smedegaardjonas.smedegaard@puri.smLibrem 5: System upgrade is undocumentedAlmost immediately after turning of my Dogwood phone first time, the system notified me of available system update.
At first I was puzzled at how to respond to the dialog - I was expecting to be able to tell it "ok, proceed now" but ther...Almost immediately after turning of my Dogwood phone first time, the system notified me of available system update.
At first I was puzzled at how to respond to the dialog - I was expecting to be able to tell it "ok, proceed now" but there was seemingly only choices of "wait" or "details" (or something similar - writing from fading memory here...).
After a moment the dialog disappeared, and I thought "hmm, maybe doing nothing means accept" - but no, a little while later it popped up again, and this time I pressed the "details" option, where it offered to "restart and update" which I chose.
Then a boot message, and then phone turned black. I waited a little while, then thought that maybe it had shut off and I should manually turn it of, so I did - but noticed that in doing so (holding down the power button for maybe 4 seconds) the previous "black" screen turned even more black, which I guess is an (very) sublt indication that I had instead turned _off_ the system.
I tried again, holding down the power button for a while and now got the boot animation, and again the system turned "black".
...and now I let it "do its thing" - and have waited for an hour now, with zero indication of any activity...
Locating at the last page of the Quick Start Guide a link to docs.puri.sm I looked for documentation of what I _should_ have expected and how I _should_ have acted, but failed to locate any documentation about system upgrade - only some notes about application updates which seems a different routine.
Keep in mind that above is *not* the bugreport - it is a confusion over whether or not ther is a bug to reported or not, because documentation lack a description of what to expect from that upgrade dialog.
In short: Seems the documentation for Librem 5 is missing coverage of system upgrades.David BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/31Finish documenting the status line2020-12-07T10:53:44ZDavid BoddieFinish documenting the status lineBluetooth, language and other indicators need to be documented.Bluetooth, language and other indicators need to be documented.EvgDavid BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/5Cellular connection2019-11-25T17:53:16ZDavid BoddieCellular connection* Unlocking the SIM card
* Configuring data connections* Unlocking the SIM card
* Configuring data connectionsDavid BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/7Add microSD card formatting2019-11-25T15:28:01ZDavid BoddieAdd microSD card formattingDescribe how to format a microSD card on the phone.Describe how to format a microSD card on the phone.David BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/8Add instructions on how to put Plasma Mobile on the phone2019-11-25T15:31:11ZDavid BoddieAdd instructions on how to put Plasma Mobile on the phoneThis overlaps with the developer documentation. Perhaps a summary could be given in the user guide and a link to the developer documentation where a detailed guide could cover all the steps properly.This overlaps with the developer documentation. Perhaps a summary could be given in the user guide and a link to the developer documentation where a detailed guide could cover all the steps properly.David BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/36Add other standard applications to the user guide2020-12-07T10:53:15ZDavid BoddieAdd other standard applications to the user guideRunning `apt depends librem5-gnome` gives a list of packages including `librem5-gnome-phone` and `librem5-gnome-base`. Expanding these and stripping out non-user-facing applications leaves us with these:
| Name | Document | Notes |
| --...Running `apt depends librem5-gnome` gives a list of packages including `librem5-gnome-phone` and `librem5-gnome-base`. Expanding these and stripping out non-user-facing applications leaves us with these:
| Name | Document | Notes |
| ------ | ------ | ----- |
| epiphany-browser | Yes | **Web Browsing** |
| evince | No | |
| gedit | No | |
| gnome-calculator | No | |
| gnome-chess | No | |
| gnome-clocks | Yes | Not yet decided |
| gnome-contacts | Yes | **Managing Contacts** |
| gnome-terminal | No | |
| gnome-usage | No | |
| gnome-weather | No | |
| kgx | No | |
| yelp | No | |
| calls | Yes | **Phone Calls** |
| chatty | Yes | **Sending and Receiving Messages** |
| gnome-bluetooth | Yes | Part of **Settings** |
| gnome-control-center | Yes | **Changing the Settings** |
| gnome-getting-started-docs | No | |
| gnome-initial-setup | Yes | **Setting up Your Phone** |
| gnome-online-accounts | Yes | Part of **Settings** |
| gnome-software | Yes | **Installing New Applications** |
| phosh | Yes | In **A Quick Tour** |
| squeekboard | Yes | **Virtual Keyboard** |David BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/9Add instructions on how to put UBports on the phone2019-11-25T15:32:09ZDavid BoddieAdd instructions on how to put UBports on the phoneThis overlaps with the developer documentation. Perhaps a summary could be given in the user guide and a link to the developer documentation where a detailed guide could cover all the steps properly. Use the same template as #8 for this.This overlaps with the developer documentation. Perhaps a summary could be given in the user guide and a link to the developer documentation where a detailed guide could cover all the steps properly. Use the same template as #8 for this.David BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/10Document all possibilities to get a serial console2019-12-18T18:53:50ZMartin KepplingerDocument all possibilities to get a serial consoleAFAIK (vaguely from a past discussion) there's (at least) 3 ways to have a console:
* software: via Linux as a USB gadget device, i.e. /dev/ttyACM0
* hardware: via USB-C pins? how exactly? breakout board?
* hardware: via dedicated "acce...AFAIK (vaguely from a past discussion) there's (at least) 3 ways to have a console:
* software: via Linux as a USB gadget device, i.e. /dev/ttyACM0
* hardware: via USB-C pins? how exactly? breakout board?
* hardware: via dedicated "accessible" points to solder a cable / connector to. (which one? where are they?)
the "hardware" ones are especially important for development and "power users".
@eric.kuzmenko and @angus.ainslie will know much more here though. Is that already informally documented in some issue or elsewhere? If not, can we summarize here?https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/11Document quick-charging method2020-09-18T17:13:49ZDavid BoddieDocument quick-charging methodFrom Todd in Matrix, approved by Eric:
1. Plug in power, push power button briefly to see the red light for charging.
2. Unplug power; push power button for 12 to 15 seconds (until light turns green); plug power back in (see red light c...From Todd in Matrix, approved by Eric:
1. Plug in power, push power button briefly to see the red light for charging.
2. Unplug power; push power button for 12 to 15 seconds (until light turns green); plug power back in (see red light come on).
3. Shutdown via shutdown UI; or power hold for 4+ seconds.
This only helps if the phone can boot to a user interface.David BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/19Update photos+text to reflect removed mounting hardware for cellular and WiFi...2020-10-13T19:50:07ZDoug WoodUpdate photos+text to reflect removed mounting hardware for cellular and WiFi modulesThe User's Manual shows modem and wifi modules held in place with screws+brackets.
However, my Dogwood phone came without these. The modules are only held in place by a plastic "clip" that is part of the shell. I'm assuming that this wa...The User's Manual shows modem and wifi modules held in place with screws+brackets.
However, my Dogwood phone came without these. The modules are only held in place by a plastic "clip" that is part of the shell. I'm assuming that this was intentional and that the mounting hardware has been removed from the BOM.
Update the text and photos to reflect the new situation.https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/20Add section about the included headset2020-09-18T16:03:17ZDoug WoodAdd section about the included headsetI initially thought the included headset was broken, because the volume rocker didn't return to its centre position. It turned out to be a potentiometer with very short throw, so works as it should, but that was not obvious to me. Especi...I initially thought the included headset was broken, because the volume rocker didn't return to its centre position. It turned out to be a potentiometer with very short throw, so works as it should, but that was not obvious to me. Especially since it was marked +/- rather than with the usual wedge-shaped crescendo symbol.
Perhaps also mention that the headset won't control the volume setting on the phone, as this might be the expectation people have coming from other phones/headsets. (So, you can't raise volume above what is already set on the phone.)https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/23call audio routing is fixed2020-09-15T15:29:02ZGuido Gunthercall audio routing is fixedhttps://docs.puri.sm/Librem_5/Known_Issues/Birch.html says `Call audio routing is not functioning completely.`. If there's still problems with call routing we should say what is broken (and link to bugs) but i think the defaults are fine...https://docs.puri.sm/Librem_5/Known_Issues/Birch.html says `Call audio routing is not functioning completely.`. If there's still problems with call routing we should say what is broken (and link to bugs) but i think the defaults are fine now.https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/24heat issues are mostly fixed2020-09-15T15:30:19ZGuido Guntherheat issues are mostly fixedhttps://docs.puri.sm/Librem_5/Known_Issues/Birch.html says 'Power management and heat issues are caused by various subsystems. The processor will be run more slowly to prevent overheating, affecting processing performance.` but i think w...https://docs.puri.sm/Librem_5/Known_Issues/Birch.html says 'Power management and heat issues are caused by various subsystems. The processor will be run more slowly to prevent overheating, affecting processing performance.` but i think we have these mostly und control now.https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/35Document indicator colors2020-10-13T14:18:41ZDavid BoddieDocument indicator colorsSee developer.puri.sm#112 for details.See developer.puri.sm#112 for details.David BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/37Outlook: Document convergent behaviour2020-10-14T07:08:49ZGuido GuntherOutlook: Document convergent behaviournothing merged) or released in phosh yet but things that come to mind
- Changes in appliction mode (resizeable, moveable windows) (https://source.puri.sm/Librem5/phosh/-/merge_requests/631)
- hiding/showing apps depending on external ou...nothing merged) or released in phosh yet but things that come to mind
- Changes in appliction mode (resizeable, moveable windows) (https://source.puri.sm/Librem5/phosh/-/merge_requests/631)
- hiding/showing apps depending on external output (no MR yet)
@david.boddie just putting this here so it doesn't come in as last minute change)https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/38Add information about serial numbers, batch identification2020-10-20T16:20:27ZDavid BoddieAdd information about serial numbers, batch identificationOnline counterpart to Librem5/quickstart-guide#19.Online counterpart to Librem5/quickstart-guide#19.David BoddieDavid Boddiehttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/40Document swipe-to-close handling2020-11-17T15:30:52ZDoug WoodDocument swipe-to-close handlingUpdate docs to reflect the new swipe-to-close handling, because it is not obvious and there are no visual cues.
/relate Librem5/phosh#205
Update docs to reflect the new swipe-to-close handling, because it is not obvious and there are no visual cues.
/relate Librem5/phosh#205
https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/41Add note about powering down the phone before removing the SIM tray2020-12-18T13:54:17ZDavid BoddieAdd note about powering down the phone before removing the SIM trayThis was covered in the known issues for Birch and Chestnut, but was supposed to be fixed for later revisions of the hardware.This was covered in the known issues for Birch and Chestnut, but was supposed to be fixed for later revisions of the hardware.https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/43Follow-up from "Added instructions to do a long press to start the phone"2021-04-21T14:13:12ZGuido GuntherFollow-up from "Added instructions to do a long press to start the phone"The following discussion from !38 should be addressed:
I think we should have
```
#. Wait at least 1h for the battery to get some charge
#. Unplug any USB device that might be connected to the phone
```
not
```
#. Unplug any USB d...The following discussion from !38 should be addressed:
I think we should have
```
#. Wait at least 1h for the battery to get some charge
#. Unplug any USB device that might be connected to the phone
```
not
```
#. Unplug any USB device that might be connected to the phone
#. Wait at least 1h for the battery to get some charge
```
while at that we could also say 'unplug the charger' rather than 'any usb device' since we said to use the charger above *and* we could say that if the led doesn't turn red it could also be because it's fully charged.
So i'd propose:
```
# ...
#. Wait at least 1h for the battery to get some charge
#. Unplug the usb charger from the phone
#. ...
```
/cc @joao.azevedoJoao AzevedoJoao Azevedohttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/44SIM pin dialog isn't on top of the lock screen2021-09-08T15:08:45ZGuido GuntherSIM pin dialog isn't on top of the lock screenWhile looking at the new theme work from @francois.techene in https://source.puri.sm/Purism/docs.puri.sm/-/merge_requests/109
i noticed that the docs says the pin dialog is above the lock screen. This isn't true for some time so this nee...While looking at the new theme work from @francois.techene in https://source.puri.sm/Purism/docs.puri.sm/-/merge_requests/109
i noticed that the docs says the pin dialog is above the lock screen. This isn't true for some time so this needs an update (and a newer screenshot would be cool too, dialogs look way different nowadays).https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/45Unreferenced pages since latest update:2022-04-08T07:14:38ZGuido GuntherUnreferenced pages since latest update:@david.hamner seems your app lit doesn't get referenced in the toc tree:
```
pickling environment... done
checking consistency... /var/scratch/librem5/librem5-user-docs-common/Apps.rst: WARNING: document isn't included in any toctree
/v...@david.hamner seems your app lit doesn't get referenced in the toc tree:
```
pickling environment... done
checking consistency... /var/scratch/librem5/librem5-user-docs-common/Apps.rst: WARNING: document isn't included in any toctree
/var/scratch/librem5/librem5-user-docs-common/Apps/App_Spotlights/Drawing.rst: WARNING: document isn't included in any toctree
/var/scratch/librem5/librem5-user-docs-common/History.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] index
/var/scratch/librem5/librem5-user-docs-common/Apps/App_Spotlights/Backups.rst:19: WARNING: undefined label: librem_computers_backups
/var/scratch/librem5/librem5-user-docs-common/Troubleshooting/Reflashing.rst:6: WARNING: undefined label: librem_computers_backups
generating indices... genindex done
writing additional pages... search done
```
Also `librem_Computers_backups` doesn't exist in the repo. Introduced by 97f03c6c9e449b4c0c3acc38b21cbb900071b989.
/cc @kyle.rankinhttps://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/46Document mobile data indicator2022-12-08T16:02:54ZGuido GuntherDocument mobile data indicatorThe "lack of mobile data" indicated by an exclamation mark (http://janvlug.org/blog/one-week-librem-5-field-trial-day-1/) doesn't seem to be obvious to people. It should be in the docs.The "lack of mobile data" indicated by an exclamation mark (http://janvlug.org/blog/one-week-librem-5-field-trial-day-1/) doesn't seem to be obvious to people. It should be in the docs.https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/47Should link to compatible adaptors list2022-05-16T10:05:07ZGuido GuntherShould link to compatible adaptors listhttps://docs.puri.sm/Librem_5/Known_Issues/Evergreen.html says
"The Librem 5 is incompatible with certain phone dock devices that rely on USB-C connections."
it could link to https://source.puri.sm/Librem5/firmware-tps6598x-nonfree/-/b...https://docs.puri.sm/Librem_5/Known_Issues/Evergreen.html says
"The Librem 5 is incompatible with certain phone dock devices that rely on USB-C connections."
it could link to https://source.puri.sm/Librem5/firmware-tps6598x-nonfree/-/blob/master/dp-alt-mode-adapters.org for a list of tested adapters and their quirks.https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/49Document that one can't flash with completely empty battery2022-09-02T13:30:09ZGuido GuntherDocument that one can't flash with completely empty batteryI've seen
```
uuu (Universal Update Utility) for nxp imx chips -- lib1.4.193
Success 0 Failure 1 ...I've seen
```
uuu (Universal Update Utility) for nxp imx chips -- lib1.4.193
Success 0 Failure 1
1:7 3/ 4 [Bulk(R):LIBUSB_ERROR_NO_DEVICE ] FB: flash -raw2sparse all librem5r4.img
```
more than once and always wondered why I would never see this.
Short answer: because I use my device too much.
Today I wanted to flash a device that had a completely empty battery and wasn't in ship mode so when pressing poweron + vol-up and inserting a USB cable it would show up on the USB bus and start trickle charging but flashing *right away* reproducibly gave above error. Not that it doesn't happen right away, it starts flashing a bit then the above error shows.
Starting over and having it charge for 30m was enough for flashing to succeed (after flashing and rebooting it's now at 3% battery so it really just needs a bit of charge to not draw too much power from the hosts USB). Might make sense to add that to the docs.
/cc @mladen @joao.azevedo in case it matters to support.https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/50Charging problems lists rare devices first2022-11-17T10:38:36ZGuido GuntherCharging problems lists rare devices firsthttps://docs.puri.sm/Librem_5/Troubleshooting/Charging.html has
- generic blurb
- birch
- chestnut
- dogwood
- evergreen
We have way more evergreen devices than the other ones so *most* of the users have to scroll a lot. So I'd propose...https://docs.puri.sm/Librem_5/Troubleshooting/Charging.html has
- generic blurb
- birch
- chestnut
- dogwood
- evergreen
We have way more evergreen devices than the other ones so *most* of the users have to scroll a lot. So I'd propose
- generic blurb
- evergreen
- dogwood
- chestnut
- birch
This should also make it simpler for users that don't know which model they own especially since the introduction fails to list evergreen:
```
If your phone fails to charge, or discharges while connected to a power source during use, determine which version of the phone you have then follow the appropriate steps for the model of phone you have (Birch, Chestnut or Dogwood).
```https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/51evergreen known issues page confusing2022-11-17T10:45:14ZGuido Guntherevergreen known issues page confusingIt says
> The Librem 5 is incompatible with certain phone dock devices that rely on USB-C connections.
As a user I wouldn't know what do with that information. It reads to me that especially usb-c connections aren't supported while wha...It says
> The Librem 5 is incompatible with certain phone dock devices that rely on USB-C connections.
As a user I wouldn't know what do with that information. It reads to me that especially usb-c connections aren't supported while what we *do* support is usb-c connected docks. What about:
> The Librem 5 supports usb-c docks, monitors and hubs however not all work. [Here's](https://source.puri.sm/Librem5/firmware-tps6598x-nonfree/-/blob/master/dp-alt-mode-adapters.org) a list of tested adapters with their limitations. These adapters are known to not work at all at the moment:
> - 1. adapter1
> - 2. adapter2
A further improvement would be to clarify what we mean by support (Video out?, USB out?)https://source.puri.sm/Librem5/librem5-user-docs-common/-/issues/52Document waydroid use2023-10-02T12:46:08ZGuido GuntherDocument waydroid useThe docs talk about Anbox which is dated and Waydroid works well (filing an issue as this come up a lot)
/cc @david.hamnerThe docs talk about Anbox which is dated and Waydroid works well (filing an issue as this come up a lot)
/cc @david.hamner