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

add zig docs support #32

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

add zig docs support #32

wants to merge 1 commit into from

Conversation

jinzhongjia
Copy link
Collaborator

This is used to add zig docs support!

@jinzhongjia
Copy link
Collaborator Author

The PR has not yet been completed, but zig-webui actually has a more detailed API document.
https://webui-dev.github.io/zig-webui/
I wonder if you can assign a subdomain name to this? @hassandraga

@jinzhongjia
Copy link
Collaborator Author

In fact, the documentation generated by zig's automatic documentation generator is more accurate and easier to maintain.

@hassandraga
Copy link
Member

hassandraga commented Jun 21, 2024

I wonder if you can assign a subdomain name to this?

I prefer not to because all wrappers will have different subdomains and different documentation. It's better to have one unified documentation for all supported languages, and this shows more WebUI's potential.

In fact, the documentation generated by zig's automatic documentation generator is more accurate

No, I don't think so. All auto-generated docs are simple. They only take the API's name and copy the above comment. Auto-generated docs are definitely quicker and time-saving, but manual handwriting documentation is more professional, detailed, and descriptive for each API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants