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

Add API section to the docs website #3349

Open
mkcp opened this issue Dec 18, 2024 · 0 comments
Open

Add API section to the docs website #3349

mkcp opened this issue Dec 18, 2024 · 0 comments
Labels
enhancement ✨ New feature or request

Comments

@mkcp
Copy link
Contributor

mkcp commented Dec 18, 2024

Is your feature request related to a problem? Please describe.

With the ongoing packager2 migration, Zarf is changing to better support users directly invoking its API rather than just using the CLI.

Describe the behavior you'd like

CLI / API docs on the website provide guidance for users on the core functionality that those utilizing Zarf as a library will benefit from. The goal is to offer a "paved road" to follow with examples and notes (where appropriate).

Describe alternatives you've considered

Godocs and doccomments form another part of the puzzle and should be complete when possible. It's ok if there's a bit of duplication between the website and doccomments, because the website is intended to show common and expected usecases.

@mkcp mkcp added the enhancement ✨ New feature or request label Dec 18, 2024
@mkcp mkcp added this to Zarf Dec 18, 2024
@github-project-automation github-project-automation bot moved this to Triage in Zarf Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement ✨ New feature or request
Projects
Status: Triage
Development

No branches or pull requests

1 participant