doc multi-file constants format #261
Conversation
|
|
docs/Reference/CLI/CLI-Syntax.md
Outdated
| @@ -1809,3 +1813,4 @@ or clear your weak subjectivity settings. | |||
| [weak subjectivity period]: ../../Concepts/Weak-Subjectivity.md | |||
| [BeaconScan chain explorer]: https://beaconscan.com/ws_checkpoint | |||
| [load new validators without restarting Teku]: ../../HowTo/Load-Validators-No-Restart.md | |||
| [MainNet resources directory]: https://github.com/ConsenSys/teku/tree/master/util/src/main/resources/tech/pegasys/teku/util/config/mainnet | |||
There was a problem hiding this comment.
Not sure it's a good idea to link to these resources here - they're slated to move in the near future and we could easily forget to update docs
There was a problem hiding this comment.
We have a nightly link check, so no risks we forget to update if they are broken.
But then if you think it will move soon we can either point to a better resource, if there's a stabler one, or include the examples directly in the doc, but then we will need you to tell us as soon as we need to update them. No solutions is perfect.
I don't think we should point to the root of the Teku repos, even if it will hopefully not change, as it will be too hard for users to find the files from there.
There was a problem hiding this comment.
The canonical place to look for config definitions is the eth2.0 spec repo here. Various testnet configs can be found here.
I'm not sure how helpful it is to include links - I think just explaining that you can use a single file, or split them up in a directory with subfiles named phase0 or altair is really all the detail I was trying to convey.
There was a problem hiding this comment.
I like the idea to have a link to example when we talk about config files. It helps having a quick understanding of the content and capabilities. Your links are nice imo. @ConsenSys/protocol-pliny what do you think?
There was a problem hiding this comment.
Pliny recommends keeping the link.
There was a problem hiding this comment.
Use one of @mbaxter 's link then, they are closer to the source of truth and should not move too much.
docs/Reference/CLI/CLI-Syntax.md
Outdated
| Predefined network configuration. | ||
| Accepts a predefined network name, or file path or URL to a YAML configuration file or directory. | ||
| Directories must hold a `phase0.yaml` file and can hold an optional `altair.yaml` file. | ||
| See the [MainNet resources directory] for an example. |
There was a problem hiding this comment.
I'd suggest just cutting this line. Can't think of a resource to link to that is guaranteed to be stable and correct.
Pull Request Description
Add documentation for multi-file config file format.
Fixed Issue(s)
fixes #259