Github user PramodSSImmaneni commented on a diff in the pull request:
https://github.com/apache/incubator-apex-malhar/pull/210#discussion_r56098364
--- Diff: docs/README.md ---
@@ -0,0 +1,46 @@
+# Apex Malhar Documentation
+
+Repository for Malhar docs available on
http://apex.incubator.apache.org/docs.html
+
+Documentation is written in
[Markdown](https://guides.github.com/features/mastering-markdown/) format and
statically generated into HTML using [MkDocs](http://www.mkdocs.org/). All
documentation is located in the [docs](docs) directory, and
[mkdocs.yml](mkdocs.yml) file describes the navigation structure of the
published documentation.
+
+## Authoring
+
+New pages can be added under [docs](docs) or related sub-category, and a
reference to the new page must be added to the [mkdocs.yml](mkdocs.yml) file to
make it availabe in the navigation. Embedded images are typically added to
images folder at the same level as the new page.
+
+When creating or editing pages, it can be useful to see the live results,
and how the documents will appear when published. Live preview feature is
available by running the following command at the root of the repository:
+
+```bash
+mkdocs serve
+```
+
+For additional details see [writing your
docs](http://www.mkdocs.org/user-guide/writing-your-docs/) guide.
+
+## Site Configuration
+
+Guides on applying site-wide
[configuration](http://www.mkdocs.org/user-guide/configuration/) and
[themeing](http://www.mkdocs.org/user-guide/styling-your-docs/) are available
on the MkDocs site.
+
+## Deployment
+
+
--- End diff --
Extra newline?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
