microraiden icon indicating copy to clipboard operation
microraiden copied to clipboard

JavaScript application README update

Open eorituz opened this issue 7 years ago • 6 comments

The JavaScript related part of the microraiden documentation currently links to:

  1. https://github.com/raiden-network/microraiden/blob/master/microraiden/webui/microraiden/README.md and
  2. https://github.com/raiden-network/microraiden/blob/master/microraiden/webui/microraiden/docs/README.md

This README is only needed once, therefore delete one of the READMEs.

eorituz avatar Feb 23 '18 13:02 eorituz

Take care with it, because the second one is actually auto-generated by TypeDoc, and "import" the header for the README from the first one. There's one option from typedoc command to exclude this import, but I think the second, auto-generated readme gets more complete with it.

andrevmatos avatar Feb 23 '18 15:02 andrevmatos

Mhhh @andrevmatos what do you recommend to do?

eorituz avatar Feb 23 '18 15:02 eorituz

Hmm, not sure.. I'd view the 1st readme more as a template/header, and let it alone. The proper/actual/auto-generated docs are in the docs/ folder, so just export it alone.

andrevmatos avatar Feb 23 '18 15:02 andrevmatos

The webui-api-docs should go to the main docs anyway. I'll look into this and see how to integrate it in sphinx.

ezdac avatar Feb 23 '18 16:02 ezdac

This looks promising how to integrate in sphinx:

  • Creating custom URL-Rules with typedoc-plugin-sourcefile-url if neccessary for compilation of the .md files
  • use recommonmark Markdown-parser plugin for sphinx

ezdac avatar Feb 23 '18 17:02 ezdac

Unfortunately ---^ is not easily integratable in sphinx. Best solution would be to modify the typedoc-markdown-theme and let it output .rst files with appropriate toc-tree and :doc:-link directives inserted. This should not be too hard, but takes some time.

ezdac avatar Feb 27 '18 13:02 ezdac