1181272 - [music] Provide developer documentation

Status: RESOLVED FIXED

(Firefox OS Graveyard :: Gaia::Music, defect)

Description

[Jim Porter (:squib)]

The music app is in desperate need of some developer docs. Dominic will be working on documenting parts of the front-end, and I'll be documenting the back-end. Later on, I'll start updating the front-end docs as well.

Comment 1

[GitHub Autolander Bot]

Attachment: [gaia] dominickuo:bug-1181272 > mozilla-b2g:master

Comment 2

[Dominic Kuo [:dkuo]]

(In reply to Autolander from comment #1)
> Created attachment 8630920 [details] [review]
> [gaia] dominickuo:bug-1181272 > mozilla-b2g:master

wip not ready yet.

Comment 3

[Dominic Kuo [:dkuo]]

Attachment: patch

I tried to form the developer documentation into pieces then fill the parts I am familiar with.

And Because it's the README format so will be easier to review by reading the formatted documentation online: https://github.com/dominickuo/gaia/blob/bug-1181272/apps/music/README.md

Comment 4

[Jim Porter (:squib)]

Comment on attachment 8636465 [details] [review]
patch

Looks good! I have one minor comment on GitHub (a markup typo). Let's land it! I'm sure most of the incomplete sections will get filled out as we finish the NGA changes for version 2.5.

Comment 5

[Dominic Kuo [:dkuo]]

(In reply to Jim Porter (:squib) from comment #4)
> Comment on attachment 8636465 [details] [review]
> patch
> 
> Looks good! I have one minor comment on GitHub (a markup typo). Let's land
> it! I'm sure most of the incomplete sections will get filled out as we
> finish the NGA changes for version 2.5.

Thanks Jim! the minor issue is actually not a typo but it looks like people might confuse, so I removed it then quote the NOT word to indicate it's important.

Comment 6

[Dominic Kuo [:dkuo]]

The README skeleton with the front-end parts are landed on master: https://github.com/mozilla-b2g/gaia/commit/1d3595836bd55b70478923d771051268a5dabf91

Comment 7

[GitHub Autolander Bot]

Attachment: [gaia] jimporter:music-metadata-doc > mozilla-b2g:master

Comment 8

[David Flanagan [:djf]]

Comment on attachment 8648895 [details] [review]
[gaia] jimporter:music-metadata-doc > mozilla-b2g:master

docs-only.  looks good!

Comment 9

[Jim Porter (:squib)]

Landed: https://github.com/mozilla-b2g/gaia/commit/89e0096a3de0378e3eda77e6a2a0bb5ca03eb8bb