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

Find a better way to document options #91

Closed
thisismydesign opened this issue Feb 10, 2020 · 3 comments
Closed

Find a better way to document options #91

thisismydesign opened this issue Feb 10, 2020 · 3 comments
Assignees

Comments

@thisismydesign
Copy link
Member

The current table approach in the readme is quite overwhelming, and a bit redundant with the example above and hard to follow.

One thing we could do is use the yml format which allows for comments and more structure. That way we could include the docs and examples in the config file itself, similar to when you'd init a new project in some frameworks.

@gomorizsolt @nkapolcs your input in welcome, can you think of other ways?

@gomorizsolt
Copy link
Collaborator

+1 for using YAML instead of JSON. This could replace the table altogether. One note on the format is that the comments should clarify which option is mandatory/optional.

@gomorizsolt
Copy link
Collaborator

On second thought, since AFAICS there's merely one mandatory option, it's sufficient to highlight this somewhere outside of the context(or right above the corresponding option).

## Configuration

Each config is optional except for the product's title if exists.

YML ...

@gomorizsolt
Copy link
Collaborator

Resolved by #106.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants