Difference between revisions of "Notes"

From PINE64
Jump to navigation Jump to search
Line 10: Line 10:
 
* Documentation of the mainline status of the phone is a big point people could look into
 
* Documentation of the mainline status of the phone is a big point people could look into
 
* Unsafe practices <b>must</b> be tagged with a template
 
* Unsafe practices <b>must</b> be tagged with a template
 +
* Kill switch documentation and functions have to be fact-checked (current information are based on randomly found information on the net!)
  
 
=== Topics ===
 
=== Topics ===

Revision as of 10:19, 12 April 2021

General notes* on how you can contribute to make the wiki a better place (* these are general ideas and not a guideline):

Pinephone article

Required

  • A proper warning in the introduction section about the state of the software, goal of the project, at which users the phone is marketed towards
  • Battery and charging safety warnings (not under pillow, no heat build-up, compatible chargers, handling of the battery etc.)
  • Make the articles ready for BSD and other OSes, too Linux-specific right now
  • A support section, directing users towards the community chat in case of issues
  • Better structure of the "first time installation" paragraph
  • Documentation of the mainline status of the phone is a big point people could look into
  • Unsafe practices must be tagged with a template
  • Kill switch documentation and functions have to be fact-checked (current information are based on randomly found information on the net!)

Topics

  • Deep sleep and push notifications
  • Sensors, battery and temperature readings
  • GPS
  • Safety, thermal emergency shutdown
  • Charging
  • Deep sleep

Improvements

  • Battery section doesn't look that good (outdated picture, random lists in the section)
  • "Carrier support" overhaul (hard to find, hard to maintain, goals of the section)
  • Accessory compatibility in general (especially: hard to maintain, goals of the section/lists, how is it tested, how good is the information quality for readers etc.)
  • Software section needs to be updated (for example removal of "What works, what doesn't", style updates, link checks)
  • Installation section should be better readable -> graphics, pictures, structure etc.-
  • Killswitches function needs to be checked according to schematics

Quality

  • Simplification of the currently used English language
  • Some graphical elements such as boxes wouldn't hurt
  • Kernel commands to read the sensors, similar to the postmarketOS wiki article (might be too OS-specific for the OS-agnostic wiki -> different variants for different OSes?)
  • More mentions of the devs, maybe a dedicated section

Long-term goals

  • Good readability
  • Nice Graphics
  • Article needs to be structured and logical (always important to read it from the eyes of an new user)
  • Secondary goal: prevent Pine's support from being drowned with unnecessary support mails if they can also ask in the chat or read the wiki
  • Independently of an user reading the wiki or not, the wiki article is likely too complicated. People asking questions in chat = the article needs to be improved

Housekeeping