Netly icon indicating copy to clipboard operation
Netly copied to clipboard

include API documentation and Guide (v4).

Open alec1o opened this issue 1 year ago • 2 comments

Is your feature request related to a problem? Please describe.

the docs of project is manual and maybe can have errors on api. and is hard mantain manual wrote, for fix that should consider include tools to generate api from sources using XML comments.

Describe the solution you'd like

A clear and concise description of what you want to happen.

Describe alternatives you've considered

  1. Found tools to generate docs from XML comments.
    1. DocFx is most easy way to do this! (Most better choice)

Additional context

If the choice is DocFx

    1. the guide must be rewrite. (current version don't have guide)

alec1o avatar Dec 22 '23 00:12 alec1o

C# API generation is working: 0fe42cea0e08e789b02bdc7725a73a254f43c8d4

alec1o avatar Jan 27 '24 12:01 alec1o

docfx harder documentation because don't have support to hot reload, the alternatives ways of hot reload using nodejs and nodemon or npm-watch is very slow and take long time to compile.

now I'll use Docsauros and to make API reference I'll use DocFxMarkdownGen

alec1o avatar Sep 06 '24 11:09 alec1o