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 · 1 comment
Open

include API documentation and Guide (v4). #32

alec1o opened this issue Dec 22, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

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 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In Progress
Development

No branches or pull requests

1 participant