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

Documentation #62

Open
lippserd opened this issue Aug 14, 2024 · 0 comments
Open

Documentation #62

lippserd opened this issue Aug 14, 2024 · 0 comments

Comments

@lippserd
Copy link
Member

Our library lacks documentation, especially about what features/packages are available, what they do and how to use them. We could use Godoc for package documentation also providing usage examples. Go's gob package is a good example of how to do this (in great detail).

I would start by documenting the config, logging and version packages, as these are most likely to be used when starting a new component. In addition, we could also introduce a scaffold where all this is used, plus an example of signal processing with signal.NotifyContext().

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

No branches or pull requests

1 participant