Skip to content

Conversation

@oxzi
Copy link
Member

@oxzi oxzi commented Nov 6, 2025

Add the bare minimum package documentation to ease external usage and finally drop a first README file.


README.md: Initial version

Add a first README.md file based on the layout used by Icinga DB.

For the moment, only the notifications package was mentioned as an
example, as others hopefully might start using this API after the
upcoming Notifications release.

References #62.

notifications: Initial Package Documentation

As the notifications API should be available for external users, a
minimum of API documentation would make a good first impression. This is
a start by adding package level documentation to the notifications
package and each subpackage.

An overview with references to subpackages was written for
notifications, while the user-facing packages got some pointers on how
to get started.

References #62.

oxzi added 2 commits November 6, 2025 12:59
As the notifications API should be available for external users, a
minimum of API documentation would make a good first impression. This is
a start by adding package level documentation to the notifications
package and each subpackage.

An overview with references to subpackages was written for
notifications, while the user-facing packages got some pointers on how
to get started.

References #62.
Add a first README.md file based on the layout used by Icinga DB.

For the moment, only the notifications package was mentioned as an
example, as others hopefully might start using this API after the
upcoming Notifications release.

References #62.
@oxzi oxzi added this to the 0.8.0 milestone Nov 6, 2025
@cla-bot cla-bot bot added the cla/signed CLA is signed by all contributors of a PR label Nov 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla/signed CLA is signed by all contributors of a PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants