Unless a developer has paid close attention to the README before trying out the gem, it may be confusing how both the initializer style config as well as the litestream.yml config gets generated at the same time.
A way to provide "just in time" documentation could be to include some # explanatory comments inside the generated config files to clarify how and when to use them.
Unless a developer has paid close attention to the README before trying out the gem, it may be confusing how both the initializer style config as well as the litestream.yml config gets generated at the same time.
A way to provide "just in time" documentation could be to include some
# explanatory commentsinside the generated config files to clarify how and when to use them.