corinthia-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Peter Kelly (JIRA)" <>
Subject [jira] [Updated] (COR-39) Introductory documentation for DocFormats
Date Tue, 10 Feb 2015 19:13:13 GMT


Peter Kelly updated COR-39:
    Issue Type: Improvement  (was: New Feature)

> Introductory documentation for DocFormats
> -----------------------------------------
>                 Key: COR-39
>                 URL:
>             Project: Corinthia
>          Issue Type: Improvement
>          Components: DocFormats - API
>            Reporter: Peter Kelly
>            Assignee: Peter Kelly
> At present, clear enunciation of exactly what DocFormats is all about has been very limited,
and understanding that exists among Corinthia developers has been mostly achieved through
mailing lists discussions.
> I (Peter) must write some introductory documentation on the Wiki explaining the philosophy
behind the library, the key operations, and how data flows through the library. This documentation
should also include the context of how DocFormats can be used in conjunction with the editor.
> This documentation will help new developers find their way around the project, as a first
step to contributing.

This message was sent by Atlassian JIRA

View raw message