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

A master reference table for all features? #91

Open
BoPeng opened this issue May 1, 2020 · 0 comments
Open

A master reference table for all features? #91

BoPeng opened this issue May 1, 2020 · 0 comments

Comments

@BoPeng
Copy link
Contributor

BoPeng commented May 1, 2020

It is difficult for users to find what SoS provides. I am thinking of a master cheatsheet / reference table like the following

statement/syntax option usage reference
action template templates for the execution of action /link/to/action/option/template
  template_name name of templates for the execution of action /link/to/action/option/template_name

Perhaps it could be separated into multiple tables by action, option, input, etc.

The point is that our "users guide" can be really really long if we try to provide example for all options, so a reference table without example can be easier to navigate.

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

No branches or pull requests

1 participant