|
|
# Proposed Structure for the Developer Documentation
|
|
|
|
|
|
What follows is an outline of a structure for the developer documentation. I'm not planning to keep it in-sync with the documentation itself once it has been used to help with restructuring. At the moment I'm just collecting requirements and references to populate it with. Note that some of the chapters will potentially become very large over time - then they may need breaking into pieces. Other chapters may be auto-generated and be published separately, though they will still be linked to from the published document.
|
|
|
|
|
|
## Introduction
|
|
|
|
|
|
Introduces the Librem 5. Describes the purpose of this document.
|
... | ... | @@ -75,12 +77,16 @@ Librem5. (issue [1](https://source.puri.sm/guido.gunther/Apps_Issues/issues/1)) |
|
|
|
|
|
#### Phone components
|
|
|
|
|
|
This may be more of an architecture issue rather than a development issue, but it helps if developers know how the system behaves.
|
|
|
|
|
|
* How they are used
|
|
|
* How they are configured
|
|
|
* How they interact with applications
|
|
|
|
|
|
#### Application interaction with the environment when using the phone
|
|
|
|
|
|
*(Perhaps part of the previous section.)*
|
|
|
|
|
|
* Priorities when standard phone features are activated (e.g. incoming calls)
|
|
|
* What happens to applications when other events occur, user changes focus?
|
|
|
|
... | ... | @@ -95,20 +101,25 @@ Also include software services that *might* be running: |
|
|
* Authentication
|
|
|
* Contacts
|
|
|
* Messaging
|
|
|
* Communication
|
|
|
* Communication (cellular, wireless)
|
|
|
|
|
|
These may also include system-level services from GNOME:
|
|
|
|
|
|
* Authentication
|
|
|
* Settings
|
|
|
* Styles/Themes
|
|
|
* ...
|
|
|
|
|
|
Information about software development that's applicable to the phone, for
|
|
|
example, say, descriptions of public phosh/oFono/Calls/virtual keyboard/etc.
|
|
|
APIs (issue [19](https://source.puri.sm/Librem5/developer.puri.sm/issues/19))
|
|
|
Information about software development that's applicable to the phone, for example, say, descriptions of public phosh/oFono/Calls/virtual keyboard/etc. APIs (issue [19](https://source.puri.sm/Librem5/developer.puri.sm/issues/19))
|
|
|
|
|
|
### Sharing/Publishing
|
|
|
#### Using Remote Services
|
|
|
|
|
|
*(Perhaps part of the previous section/manual.)*
|
|
|
Interacting with remote services (if available):
|
|
|
|
|
|
* File sharing
|
|
|
* ...
|
|
|
|
|
|
### Sharing/Publishing
|
|
|
|
|
|
* Submitting apps to app store/getting apps published:
|
|
|
*Once there's an app store in place, we will need to provide a how-to on submitting their apps.* (issue [19](https://source.puri.sm/Librem5/developer.puri.sm/issues/19))
|
... | ... | |