Difference between revisions of "Notes"

From PINE64
Jump to navigation Jump to search
(Added article)
 
(Style)
Line 3: Line 3:
== Pinephone article ==
== Pinephone article ==
=== Required ===
=== Required ===
- The next batch needs to be added to the article (intro, hardware revisions section etc.)
* The next batch needs to be added to the article (intro, hardware revisions section etc.)
- 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
* 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
- Make the articles ready for BSD and other OSes, too Linux-specific right now
* 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
* A support section, directing users towards the community chat in case of issues
- Better structure of the "first time installation" paragraph
* Better structure of the "first time installation" paragraph
- (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


=== Improvements ===
=== Improvements ===
- Battery section doesn't look that good (outdated picture, random lists in the section)
* 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)
* "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.)
* 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)
* 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.
* Installation section should be better readable -> graphics, pictures, structure etc.


=== Quality ===
=== Quality ===
- Simplification of the currently used English language
* Simplification of the currently used English language
- Some graphical elements such as boxes wouldn't hurt
* 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?)
* 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
* More mentions of the devs, maybe a dedicated section


=== Long-term goals ===
=== Long-term goals ===
- Good readability
* Good readability
- Nice Graphics
* Nice Graphics
- Article needs to be structured and logical (always important to read it from the eyes of an new user)
* 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
* 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
* 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

Revision as of 16:05, 17 March 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

  • The next batch needs to be added to the article (intro, hardware revisions section etc.)
  • 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
  • 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

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.

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