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

Top-level library documentation #4

Open
cbgbt opened this issue Sep 12, 2023 · 0 comments
Open

Top-level library documentation #4

cbgbt opened this issue Sep 12, 2023 · 0 comments

Comments

@cbgbt
Copy link
Contributor

cbgbt commented Sep 12, 2023

DoD:
bottlerocket_settings_sdk::lib has a docstring containing:

  • Context for the library's existence
  • A quickstart guide
  • References to common (anticipated) usage patterns
  • Any gotchas that users should be aware of
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
No milestone
Development

No branches or pull requests
1 participant
@cbgbt