From 5972a3e6fe569410e99f38d128f410b6482615b2 Mon Sep 17 00:00:00 2001
From: Floris Bruynooghe <flub@n0.computer>
Date: Tue, 23 Jul 2024 12:01:09 +0200
Subject: [PATCH] Add some useful reminders

---
 iroh-cli/src/config.rs    | 2 ++
 iroh-cli/src/logging.rs   | 3 +++
 iroh-net/src/relay/map.rs | 2 ++
 iroh/src/node/builder.rs  | 2 ++
 4 files changed, 9 insertions(+)

diff --git a/iroh-cli/src/config.rs b/iroh-cli/src/config.rs
index 84a80651aa..5f5ec2b753 100644
--- a/iroh-cli/src/config.rs
+++ b/iroh-cli/src/config.rs
@@ -49,6 +49,8 @@ impl ConsolePaths {
 }
 
 /// The configuration for an iroh node.
+// Please note that this is documented in the `iroh.computer` repository under
+// `src/app/docs/reference/config/page.mdx`.  Any changes to this need to be updated there.
 #[derive(PartialEq, Eq, Debug, Deserialize, Clone)]
 #[serde(default, deny_unknown_fields)]
 pub(crate) struct NodeConfig {
diff --git a/iroh-cli/src/logging.rs b/iroh-cli/src/logging.rs
index c06bf29b1b..561a8f95b4 100644
--- a/iroh-cli/src/logging.rs
+++ b/iroh-cli/src/logging.rs
@@ -97,6 +97,9 @@ pub(crate) fn init_terminal_logging() -> anyhow::Result<()> {
     Ok(())
 }
 
+/// Configuration for the logfiles.
+// Please note that this is documented in the `iroh.computer` repository under
+// `src/app/docs/reference/config/page.mdx`.  Any changes to this need to be updated there.
 #[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
 #[serde(default, deny_unknown_fields)]
 pub(crate) struct FileLogging {
diff --git a/iroh-net/src/relay/map.rs b/iroh-net/src/relay/map.rs
index 3e3d8a8434..ebd49f6d69 100644
--- a/iroh-net/src/relay/map.rs
+++ b/iroh-net/src/relay/map.rs
@@ -116,6 +116,8 @@ impl fmt::Display for RelayMap {
 /// Information on a specific relay server.
 ///
 /// Includes the Url where it can be dialed.
+// Please note that this is documented in the `iroh.computer` repository under
+// `src/app/docs/reference/config/page.mdx`.  Any changes to this need to be updated there.
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, PartialOrd, Ord)]
 pub struct RelayNode {
     /// The [`RelayUrl`] where this relay server can be dialed.
diff --git a/iroh/src/node/builder.rs b/iroh/src/node/builder.rs
index 4623261724..a208cdaa94 100644
--- a/iroh/src/node/builder.rs
+++ b/iroh/src/node/builder.rs
@@ -802,6 +802,8 @@ impl<D: iroh_blobs::store::Store> ProtocolBuilder<D> {
 }
 
 /// Policy for garbage collection.
+// Please note that this is documented in the `iroh.computer` repository under
+// `src/app/docs/reference/config/page.mdx`.  Any changes to this need to be updated there.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
 pub enum GcPolicy {
     /// Garbage collection is disabled.