Re: [Varnamproject-discuss] Documentation

[Navaneeth K N]

That is great. Look at how `Jekyll` has done the documentation[1]. We could 
follow a similar approach. Getting started, compilation instructions, setting 
up ibus etc.

For now, you can write in plain markdown and we will integrate it to the 
website later. I was planning to make the website completely static and host it 
on Github pages. This way, the varnam server needs to handle only API calls. 
Something like, api.varnamproject.com. So after this is done, all these 
markdown files can be merged to the github pages repository. We need to also 
write a documentation on using the API. 

There are some docs available at[2]. Take a look at that as a starting point. 

Thank you for taking up this.

[1]: http://jekyllrb.com/docs/home/
[2]: http://www.varnamproject.com/docs


On 06-Sep-2014, at 7:18 pm, Kevin Martin <address@hidden> wrote:

> Hi,
> 
> I'll be getting some free time during the onam holidays. I'd like to help 
> with some documentation. Can you suggest a place to start?
> 
>