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

🚀 [Feature]: Auto-generate all docs #2401

Open
3 tasks done
leonklingele opened this issue Apr 2, 2023 · 2 comments
Open
3 tasks done

🚀 [Feature]: Auto-generate all docs #2401

leonklingele opened this issue Apr 2, 2023 · 2 comments

Comments

@leonklingele
Copy link
Member

Feature Description

Just as the official Go code base, we should automatically generate all our documentation.

Also example-code can be documented using only Go itself: https://pkg.go.dev/fmt#example-package-Formats
The examples are even tested if they really produce the expected output — super nice! Also see https://github.com/golang/go/blob/8edcdddb23c6d3f786b465c43b49e8d9a0015082/src/fmt/example_test.go#L16-L24

Refs #2344

Additional Context (optional)

No response

Code Snippet (optional)

No response

Checklist:

  • I agree to follow Fiber's Code of Conduct.
  • I have checked for existing issues that describe my suggestion prior to opening this one.
  • I understand that improperly formatted feature requests may be closed without explanation.
@efectn
Copy link
Member

efectn commented Apr 2, 2023

Sounds good idea. Most part of our docs can be generated automatically.

@JoelLau
Copy link

JoelLau commented Oct 15, 2023

@efectn mind i take a stab at this as part of this year's hacktoberfest?

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

No branches or pull requests

4 participants