Menu

#17 Documentation

1.0
closed
None
2015-06-12
2015-03-10
No

A readme file at the root of the project should be created which includes the following:

  • Details about the .rro file format.

Discussion

  • Charles Hill

    Charles Hill - 2015-03-18

    The file format is plain text and the data within is formatted as JSON. The structure is as follows:

    {
        "name": "Name of the diagram",
        "graph": { /* graph data */ }
    }
    

    Detailed information about the structure of the graph data can be found here.

    Where would be a good place to document this information?

     

    Last edit: Charles Hill 2015-03-18
  • Charles Hill

    Charles Hill - 2015-03-24
    • Status: open --> pending
     
  • Charles Hill

    Charles Hill - 2015-03-31
    • Status: pending --> closed
     
  • David Durman

    David Durman - 2015-05-07

    Create a README.md file documenting rro format.

     
  • David Durman

    David Durman - 2015-05-07
    • status: closed --> open
     
  • Charles Hill

    Charles Hill - 2015-06-04
    • summary: Documentation of RRO file format --> Documentation
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -1,3 +1,3 @@
    -From the specification, in reference to loading/saving from/to file:
    +A readme file at the root of the project should be created which includes the following:
    
    -> "Please include documentation about the file format that is used."
    +* Details about the `.rro` file format.
    
     
  • Charles Hill

    Charles Hill - 2015-06-12

    Completed by commit cf690c

     
  • Charles Hill

    Charles Hill - 2015-06-12
    • status: open --> closed
     

Log in to post a comment.

MongoDB Logo MongoDB