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.

Sign up for GitHub

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

Jump to bottom

Go-Library: Documentation #563

Open
JanHoefelmeyer opened this issue Aug 13, 2024 · 1 comment
Open

Go-Library: Documentation #563

JanHoefelmeyer opened this issue Aug 13, 2024 · 1 comment
Milestone
Prerelease for ve...

Comments

@JanHoefelmeyer
Copy link
Contributor

The library needs proper documentation. This includes a README that describes the library, its functions and use cases.
The documentation of all functions also must happen automatically on release via GitHub-Actions and must be provided via a website, e.g. a ReadTheDocs documentation.
@JanHoefelmeyer JanHoefelmeyer added this to the Go-Library milestone Sep 4, 2024
@koplas
Copy link
Contributor

koplas commented Jan 24, 2025

The documentation is now available here: https://pkg.go.dev/github.com/gocsaf/csaf/v3@main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Prerelease for version 4 (towards bet...
Development

No branches or pull requests
2 participants
@koplas @JanHoefelmeyer