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

First attempt at formally documenting available config settings. #415

Merged
merged 2 commits into from
Jul 17, 2022

Conversation

yb66
Copy link
Collaborator

@yb66 yb66 commented Jul 3, 2022

As TOML allows comments I made it into a TOML file that can double as
a template config that someone can just drop in and get started, killing
two birds with one stone.

I'm not sure I got all the settings but it's a start.

docs: Added config settings to documentation.

Checklist

If applicable:

  • I have updated CHANGELOG.md
  • I have updated the documentation (README.md, docs/, demos/)

@yb66
Copy link
Collaborator Author

yb66 commented Jul 3, 2022

Btw, I signed the Google CLA but I'm unclear if I need to do something more like link to it somehow? If so, just let me know.

Regards,
iain

Copy link
Owner

@martinvonz martinvonz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for starting this doc!

docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.toml Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
Copy link
Owner

@martinvonz martinvonz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks again. Please squash all the commits except for the config template. Feel free to leave that commit in the PR, however (in this project, we care about permanent commits but we don't care about ephemeral PRs).

docs/config.md Outdated Show resolved Hide resolved
@martinvonz martinvonz enabled auto-merge (rebase) July 17, 2022 04:15
@martinvonz martinvonz merged commit 980004e into martinvonz:main Jul 17, 2022
This pull request was closed.
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 this pull request may close these issues.

2 participants