Bug 403875 - [doc] Provide agent modules documentation in git repository
Summary: [doc] Provide agent modules documentation in git repository
Status: RESOLVED FIXED
Alias: None
Product: Mihini
Classification: IoT
Component: Agent (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows 7
: P1 critical (vote)
Target Milestone: 0.9 M1   Edit
Assignee: Romain Perier CLA
QA Contact: Robert Jacolin CLA
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-03-20 06:55 EDT by Cuero Bugot CLA
Modified: 2013-05-22 10:57 EDT (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Cuero Bugot CLA 2013-03-20 06:55:39 EDT 
* The doc use Markdown format and is organized under doc/ subdiretory.
* Need to update hudson build process in order to include doc generation and publication on Mihini website
* Update the wiki to link to that documentation
Comment 1 Romain Perier CLA 2013-04-05 05:21:33 EDT 
Almost done to 95%. Remaining documentation is the Embedded Micro Protocol (EMP) and the Agent User Guide.

The documentation is provided as markdown files in the directory doc/md.

For now, if you plan to build the documentation :

1. install pandoc with your package manager
$ bin/build.sh
$ cd build.default
$ make mdoc
$ xdg-open doc/md/index.html


Enjoy ;)
Comment 2 Laurent Barthelemy CLA 2013-04-10 05:04:27 EDT 
Last document (userguide) have been pushed in md format in commit b90200b6513c25061f4311f5faa77859dd228e5a