We could publish the document on the Web. And everyone could read it very easily, not only read it in local with "make doc-server".
Hi guys, We could publish the doc in gh-pages branch in GitHub, like this: http://evanxd.github.io/marionette_js_client/out/ It's a easy way, and it could keep the doc sync with code. And we could add a new command in Makefile for publishing the doc. For example, "make publish-doc". How do you guys think?
Hey Evan, If I understand you correctly, we already have a solution for this. Have you seen the `doc-publish` target? https://github.com/mozilla-b2g/marionette-js-client/blob/3483cb052ca121f5948c6cf86110fc7f0712973f/Makefile#L22-L32
Hi Mike, Sorry, I didn't see the 'doc-publish' before. So cool! We could read the doc in http://mozilla-b2g.github.io/marionette-js-client/api-docs/. But the 'doc-publish' command might have issue with .gitignore file in https://github.com/mozilla-b2g/marionette-js-client/blob/master/.gitignore#L4. For now, after we do 'doc-publish', it will show 'no files added'. We could fix that here. And the doc in GitHub seems be out of date. So we should do 'doc-publish' each time after we update the code affected the doc, right?
Created attachment 803482 [details] Pull request Hi Mike, Please help review the patch. Thanks. :)
master: https://github.com/mozilla-b2g/marionette-js-client/commit/f21fb274a3b0809d1b5a2164fb79a19766c0e758 r=lightsofapollo
Status: NEW → RESOLVED
Last Resolved: 5 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.