Create documentation using Processing docs tools

[gaocegege]

Please help migrate documentation from Processing to Processing.R -- pick any function and add a reference page, example, and test!

Detailed instructions here:

• https://github.com/gaocegege/Processing.R/wiki/How-to-document-Processing.R

ref https://github.com/gaocegege/Processing.R/wiki/Documentation-and-E2E-Test-Generator-Tool

[gaocegege]

@jeremydouglass Maybe we could get some docs or help from the community about how to use those tools.

[jeremydouglass]

Good idea. There are also multiple tools -- we are starting with public web documentation for beginners. Separately Processing also uses a python / XML / JavaDoc documentation build system do technical documentation.

• https://github.com/processing/processing-docs/blob/master/java_generate/GenerateDescriptions.py

[gaocegege]

I have created a new repo: https://github.com/Processing-R/Processing.R-docs for documentation.

[gaocegege]

FMI: https://github.com/kazimuth/processing-py-site is the web reference site for processing.py

I prefer p5.js doc, and try to fork it 🤔

[gaocegege]

ref https://processing-r.github.io/Processing.R-docs/

Tring to generate reference from examples/reference, although it is full of bugs. Documentation is much more difficult than programming. 😪

[gaocegege]

I have built a tool to generate docs from examples/reference.

The structure of examples/reference should be:

examples/
  reference/
    <function-name>/
      .property.yml
      <function-name>1/
        <function-name>1.rpde
      <function-name>2/
      ...

The structure of .property.yml, see examples/reference/arc/.property.yml as a example:

category: <category of the functino>
subcategory: <subcategory of the function>
description: <descriptinon of the function>
syntax: <syntax of the function>
parametes:
  - label: <name of the parameter>
    description: <description of the parameter>
  - ...
related:
  - <name of related function>
  - ...

[jeremydouglass]

Excellent!

If this format endures you should take the notes from this page and put it in a wiki page.

Is the idea to have this eventually move to https://github.com/Processing-R/Processing.R-docs ? Should the examples/reference sketches go there?

[jeremydouglass]

Is the concept still to integrate the examples with both documentation and unit test cases ( #10 )? Or will they be separate?

How would this integration work if the documentation is in a separate repository?

[gaocegege]

I think the example/references will be in this repo, Processing.R-docs will read from this repo. It needs a parameter which is the location of the source code of Processing.R, then it will find the example/references folder.

[gaocegege]

I have invited some friends of me to contribute to Processing.R, so rewrite the first comment and put TODO list here:

Tasks (category):

#131

[jeremydouglass]

Expanded the instructions above to explain how you know what hasn't been done / where to find it.

[jeremydouglass]

Expanded instructions and migrated to wiki page for now -- easier to find and read than in an issue, and we want to keep them even after this issue is closed.

https://github.com/gaocegege/Processing.R/wiki/How-to-document-Processing.R

[gaocegege]

Close via #131