The TOML configuration file is documented in example.config.toml - every option is listed with its default value and an inline comment. But the README never links to it directly: it just says "please checkout an example configuration file" / "please check configuration file example", which is easy to skim past when looking for a config reference. This patch: - makes example.config.toml an explicit link in the "Prepare a configuration file" section and calls it out as the configuration documentation; - adds the same link to the Doppelganger and Metrics sections, which also point readers at the example file. No content/option changes - README only.pull/481/head
|
|
||
| 384 |
|
384 |
|
| 385 |
|
385 |
|
| 386 |
|
386 |
|
| 387 |
|
|
|
| 388 |
|
|
|
| 389 |
|
|
|
|
387 |
|
|
|
388 |
|
|
|
389 |
|
|
|
390 |
|
|
|
391 |
|
|
|
392 |
|
|
|
393 |
|
|
|
394 |
|
|
| 390 |
|
395 |
|
| 391 |
|
396 |
|
| 392 |
|
397 |
|
|
|
||
| 396 |
|
401 |
|
| 397 |
|
402 |
|
| 398 |
|
403 |
|
| 399 |
|
|
|
| 400 |
|
|
|
| 401 |
|
404 |
|
| 402 |
|
405 |
|
| 403 |
|
406 |
|
|
|
||
| 467 |
|
470 |
|
| 468 |
|
471 |
|
| 469 |
|
472 |
|
| 470 |
|
|
|
| 471 |
|
|
|
|
473 |
|
|
|
474 |
|
|
| 472 |
|
475 |
|
| 473 |
|
476 |
|
| 474 |
|
477 |
|
|
|
||
| 562 |
|
565 |
|
| 563 |
|
566 |
|
| 564 |
|
567 |
|
| 565 |
|
|
|
| 566 |
|
|
|
|
568 |
|
|
|
569 |
|
|
|
570 |
|
|
| 567 |
|
571 |
|
| 568 |
|
572 |
|
| 569 |
|
573 |
|