Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

include API documentation and Guide (v4). #32

Open
alec1o opened this issue Dec 22, 2023 · 2 comments
Open

include API documentation and Guide (v4). #32

alec1o opened this issue Dec 22, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation Solved Question/Ask solved.

Comments

@alec1o
Copy link
Owner

alec1o commented Dec 22, 2023

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 alec1o added the documentation Improvements or additions to documentation label Dec 22, 2023
@alec1o alec1o self-assigned this Dec 22, 2023
@alec1o alec1o added this to Netly Dec 22, 2023
@alec1o alec1o changed the title include API documentation and Guide. include API documentation and Guide (v4). Dec 22, 2023
@alec1o
Copy link
Owner Author

alec1o commented Jan 27, 2024

C# API generation is working: 0fe42ce

@alec1o alec1o moved this to Todo in Netly Feb 9, 2024
@alec1o alec1o moved this from Todo to In Progress in Netly Mar 13, 2024
@alec1o
Copy link
Owner Author

alec1o commented Sep 6, 2024

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 alec1o added the Solved Question/Ask solved. label Oct 7, 2024
Repository owner locked as resolved and limited conversation to collaborators Oct 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation Solved Question/Ask solved.
Projects
Status: In Progress
Development

No branches or pull requests

1 participant