add(docs): Note default path to config in docs

README.md

@@ -117,6 +117,14 @@ sections in the book for more details.
 
 #### Optional Configs & Features
 
+##### Initializing Configuration File
+
+```console
+zebrad generate -o ~/.config/zebrad.toml
+```
+
+The above command places the generated `zebrad.toml` config file in the default preferences directory of Linux. For other OSes default locations [see here](https://docs.rs/dirs/latest/dirs/fn.preference_dir.html).
+
 ##### Configuring Progress Bars
 
 Configure `tracing.progress_bar` in your `zebrad.toml` to

zebra-state/src/config.rs

@@ -45,7 +45,7 @@ pub struct Config {
     /// | Linux   | `$XDG_CACHE_HOME/zebra` or `$HOME/.cache/zebra` | `/home/alice/.cache/zebra`           |
     /// | macOS   | `$HOME/Library/Caches/zebra`                    | `/Users/Alice/Library/Caches/zebra`  |
     /// | Windows | `{FOLDERID_LocalAppData}\zebra`                 | `C:\Users\Alice\AppData\Local\zebra` |
-    /// | Other   | `std::env::current_dir()/cache/zebra`           | `/cache/zebra`                       |
+    /// | Other   | `std::env::current_dir()/.cache/zebra`          | `/.cache/zebra`                      |
     ///
     /// # Security
     ///

zebrad/src/commands/generate.rs

@@ -44,6 +44,16 @@ impl Runnable for GenerateCmd {
 # 1. The -c flag on the command line, e.g., `zebrad -c myconfig.toml start`;
 # 2. The file `zebrad.toml` in the users's preference directory (platform-dependent);
 # 3. The default config.
+#
+# The user's preference directory and the default path to the `zebrad` config are platform dependent,
+# based on `dirs::preference_dir`, see https://docs.rs/dirs/latest/dirs/fn.preference_dir.html:
+#
+# | Platform | Value                                 | Example                                        |
+# | -------- | ------------------------------------- | ---------------------------------------------- |
+# | Linux    | `$XDG_CONFIG_HOME` or `$HOME/.config` | `/home/alice/.config/zebrad.toml`              |
+# | macOS    | `$HOME/Library/Preferences`           | `/Users/Alice/Library/Preferences/zebrad.toml` |
+# | Windows  | `{FOLDERID_RoamingAppData}`           | `C:\Users\Alice\AppData\Local\zebrad.toml`     |
+# | Other    | `std::env::current_dir()/.config`     | `/.config/zebrad.toml`                         |
 
 "
         .to_owned();

zebrad/src/config.rs

@@ -11,6 +11,18 @@ use serde::{Deserialize, Serialize};
 /// The `zebrad` config is a TOML-encoded version of this structure. The meaning
 /// of each field is described in the documentation, although it may be necessary
 /// to click through to the sub-structures for each section.
+///
+/// The path to the configuration file can also be specified with the `--config` flag when running Zebra.
+///
+/// The default path to the `zebrad` config is platform dependent, based on
+/// [`dirs::preference_dir`](https://docs.rs/dirs/latest/dirs/fn.preference_dir.html):
+///
+/// | Platform | Value                                 | Example                                        |
+/// | -------- | ------------------------------------- | ---------------------------------------------- |
+/// | Linux    | `$XDG_CONFIG_HOME` or `$HOME/.config` | `/home/alice/.config/zebrad.toml`              |
+/// | macOS    | `$HOME/Library/Preferences`           | `/Users/Alice/Library/Preferences/zebrad.toml` |
+/// | Windows  | `{FOLDERID_RoamingAppData}`           | `C:\Users\Alice\AppData\Local\zebrad.toml`     |
+/// | Other    | `std::env::current_dir()/.config`     | `/.config/zebrad.toml`                         |
 #[derive(Clone, Default, Debug, Eq, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields, default)]
 pub struct ZebradConfig {

zebrad/src/lib.rs

@@ -54,6 +54,18 @@
 //! - Additional contexts: wider target deployments for people to use a consensus
 //!   node in more contexts e.g. mobile, wasm, etc.
 //!
+//! ## Configuration
+//!
+//! The command below places the generated `zebrad.toml` config file in the default preferences directory of Linux:
+//!
+//! ```console
+//! zebrad generate -o ~/.config/zebrad.toml
+//! ```
+//!
+//! For other OSes default locations [see here](https://docs.rs/dirs/latest/dirs/fn.preference_dir.html).
+//!
+//! See [`config::ZebradConfig`] for more information.
+//!
 //! ## Zebra Feature Flags
 //!
 //! The following `zebrad` feature flags are available at compile time: