Skip to content

(proposal) Reflect configuration defaults in readme #46

Description

@fedorkanin

The configuration section in README.md does not show the defaults, but rather some other values. It's often wise to combine the two things: showing defaults and showing config structure. What can be done with regard to this matter:

  1. Values can be replaced with the default ones. This should be mentioned in the text, something like "here are the defaults that you can replace".
  2. Non-default values can be kept, comments with defaults can be added.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions