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 docs #170

Closed
Tracked by #126
mordamax opened this issue Mar 1, 2023 · 0 comments · Fixed by #162
Closed
Tracked by #126

improve docs #170

mordamax opened this issue Mar 1, 2023 · 0 comments · Fixed by #162

Comments

@mordamax
Copy link
Contributor

mordamax commented Mar 1, 2023

In order to skip showing the "sample" example introduced an "exclude" flag to skip from docs.
We could simply delete "sample" and there's no problem but i found it useful often to check quickly that gitlab jobs with parameters work, so would prefer to keep.

  • Docs:
    • support "example" field from type_rule
    • skip rendering a table with args, if there's no args (also make it not required)
    • make help/clean so they go as first basic commands in docs
    • add "excluded" to schema, so some commands could be skipped in docs
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

Successfully merging a pull request may close this issue.

1 participant