Revision history [back]

What should SailfishOS documentation be providing?

We're doing a review of the documentation around SailfishOS and want to start getting some input.

At the moment we're pulling together an outline and would be interested in what you'd like to see.

Here's a summary (sorry for the bullet mess - TJC bullet points only go 2 deep!)

Navigation
Introduction
- Welcome to SailfishOS
- Understanding Open Source
User guide / Tutorial
Guides by role / process / task (HOWTO)
- Development Roles
- - Introduction
- - Application developer
- - UI developer
- - Platform developer
- - HA developer
- - Build / Release engineer
- - QA engineer
- Collaborative development process
- Tasks
Platform Information (Coding Reference)
- Architecture
- - Overview
- - Packaging
- - Security
- - Internationalisation/Localisation
- - Qt
- - Core Areas / APIs (including SFOS Apps)
- UI
- - Principles
- - Interactions
- - Silica Component API
- Hardware
- - Hardware Adaptation Development Kit
- - Flashing
- - Devices
- Android Compatibility
Tools (Tool Reference)
- Application SDK
- Platform SDK
- Development tools
- Systems
Releases
Supporting Systems
- SSU
- Store

So - anything missing? Ideas, suggestions etc.

What should SailfishOS documentation be providing?

We're doing a review of the documentation around SailfishOS and want to start getting some input.

At the moment we're pulling together an outline and would be interested in what you'd like to see.

Here's a summary (sorry for the bullet mess - TJC bullet points only go 2 deep!)

Navigation
Introduction
- Welcome to SailfishOS
- Understanding Open Source
User guide / Tutorial
Guides by role / process / task (HOWTO)
- Development ~~Roles~~
- Roles
  - Introduction
- - Application developer
- - UI developer
- - Platform developer
- - HA developer
- - Build / Release engineer
- - QA engineer
- Collaborative development process
- Tasks
Platform Information (Coding Reference)
- ~~Architecture~~
- Architecture
  - Overview
- - Packaging
- - Security
- - Internationalisation/Localisation
- - Qt
- - Core Areas / APIs (including SFOS Apps)
- UI
- UI
  - Principles
- - Interactions
- - Silica Component API
- ~~Hardware~~
- Hardware
  - Hardware Adaptation Development Kit
- - Flashing
- - Devices
- Android Compatibility
Tools (Tool Reference)
- Application SDK
- Platform SDK
- Development tools
- Systems
Releases
Supporting Systems
- SSU
- Store

So - anything missing? Ideas, suggestions etc.

What should SailfishOS documentation be providing?

We're doing a review of the documentation around SailfishOS and want to start getting some input.

At the moment we're pulling together an outline and would be interested in what you'd like to see.

Here's a ~~summary (sorry for the bullet mess - TJC bullet points only go 2 deep!)~~summary

Navigation
Introduction
- Welcome to SailfishOS
- Understanding Open Source
User guide / Tutorial
Guides by role / process / task (HOWTO)
- Development Roles
  - Introduction
  - Application developer
  - UI developer
  - Platform developer
  - HA developer
  - Build / Release engineer
  - QA engineer
- Collaborative development process
- Tasks
Platform Information (Coding Reference)
- Architecture
  - Overview
  - Packaging
  - Security
  - Internationalisation/Localisation
  - Qt
  - Core Areas / APIs (including SFOS Apps)
- UI
  - Principles
  - Interactions
  - Silica Component API
- Hardware
  - Hardware Adaptation Development Kit
  - Flashing
  - Devices
- Android Compatibility
Tools (Tool Reference)
- Application SDK
- Platform SDK
- Development tools
- Systems
Releases
Supporting Systems
- SSU
- Store

So - anything missing? Ideas, suggestions etc.

What should SailfishOS documentation be providing?

We're doing a review of the documentation around SailfishOS and want to start getting some input.

At the moment we're pulling together an outline and would be interested in what you'd like to see.

Here's a summary

Navigation
Introduction
- Welcome to SailfishOS
- Understanding Open Source
User guide / Tutorial
Guides by role / process / task (HOWTO)
- Development Roles
  - Introduction
  - Application developer
  - UI developer
  - Platform developer
  - HA developer
  - Build / Release engineer
  - QA engineer
- Collaborative development process
- Tasks
Platform Information (Coding Reference)
- Architecture
  - Overview
  - Packaging
  - Security
  - Internationalisation/Localisation
  - Qt
  - Core Areas / APIs (including SFOS Apps)
- UI
  - Principles
  - Interactions
  - Silica Component API
- Hardware
  - Hardware Adaptation Development Kit
  - Flashing
  - Devices
- Android Compatibility
Tools (Tool Reference)
- Application SDK
- Platform SDK
- Development tools
- Systems
Releases
Supporting Systems
- SSU
- Store

So - anything missing? Ideas, suggestions ~~etc.~~etc. (For 'new' topics/ideas reply as answers rather than comments - but then comments on these answers is fine to group ideas together)

What should SailfishOS documentation be providing?

We're doing a review of the documentation around SailfishOS and want to start getting some input.

At the moment we're pulling together an outline and would be interested in what you'd like to see.

Here's a summary

Navigation
Introduction
- Welcome to SailfishOS
- Understanding Open Source
User guide / Tutorial
Guides by role / process / task (HOWTO)
- Development Roles
  - Introduction
  - Application developer
  - UI developer
  - Platform developer
  - HA developer
  - Build / Release engineer
  - QA engineer
- Collaborative development process
- Tasks
Platform Information (Coding Reference)
- Architecture
  - Overview
  - Packaging
  - Security
  - Internationalisation/Localisation
  - Qt
  - Core Areas / APIs (including SFOS Apps)
- UI
  - Principles
  - Interactions
  - Silica Component API
- Hardware
  - Hardware Adaptation Development Kit
  - Flashing
  - Devices
- Android Compatibility
Tools (Tool Reference)
- Application SDK
- Platform SDK
- Development tools
- Systems
Releases
Supporting Systems
- SSU
- Store

So - anything missing? Ideas, suggestions etc. (For 'new' topics/ideas reply as answers rather than comments - but then comments on these answers is fine to group ideas together)

What should SailfishOS documentation be providing?

We're doing a review of the documentation around SailfishOS and want to start getting some input.

This is likely to be a sailfishos.org site and is intended for everyone (community, companies) interested in sfos development in any role (apps, UI, middleware, hardware, sysadmin, management...)

At the moment we're pulling together an outline and would be interested in what you'd like to see.

Here's a summary

Navigation
Introduction
- Welcome to SailfishOS
- Understanding Open Source
User guide / Tutorial
Guides by role / process / task (HOWTO)
- Development Roles
  - Introduction
  - Application developer
  - UI developer
  - Platform developer
  - HA developer
  - Build / Release engineer
  - QA engineer
- Collaborative development process
- Tasks
Platform Information (Coding Reference)
- Architecture
  - Overview
  - Packaging
  - Security
  - Internationalisation/Localisation
  - Qt
  - Core Areas / APIs (including SFOS Apps)
- UI
  - Principles
  - Interactions
  - Silica Component API
- Hardware
  - Hardware Adaptation Development Kit
  - Flashing
  - Devices
- Android Compatibility
Tools (Tool Reference)
- Application SDK
- Platform SDK
- Development tools
- Systems
Releases
Supporting Systems
- SSU
- Store

So - anything missing? Ideas, suggestions etc. (For 'new' topics/ideas reply as answers rather than comments - but then comments on these answers is fine to group ideas together)