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

Improve documentation of available features and options #50

Open
lerebear opened this issue Mar 8, 2024 · 0 comments
Open

Improve documentation of available features and options #50

lerebear opened this issue Mar 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@lerebear
Copy link
Owner

lerebear commented Mar 8, 2024

The configuration docs in the README have started to lag behind the functionality provided by this action. Although the JSON schema does have a canonical catalog of all available options, users of this action don't ordinarily have a reason to look at it, and I doubt many would.

We should provide a complete, human-readable guide to all the configuration options provided by this action. One approach to doing this might be to write formal documentation in the JSON schema, and then serialize to a a more readable format (e.g. YAML, so we have a catalog similar to what's provided in the README of actions/checkout).

@lerebear lerebear added the documentation Improvements or additions to documentation label Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

1 participant