Merge pull request #1746 from hydephp/update-dotenv-example-file-documentation

emmadesilva · web-flow · commit 1a6ac5c85964 · 2024-06-28T10:53:41.000+02:00
Update site URL documentation to contain more details on its usages
diff --git a/.env.example b/.env.example
@@ -1,4 +1,4 @@
-# If you have a domain, you should set the URL here so that permalinks can be generated. You can also set it in the config/hyde.php file.
+# If you have a domain, you should set the URL here so that sitemaps, RSS feeds, and permalinks can be generated. You can also set it in the config/hyde.php file.
 SITE_URL=http://localhost
 
 # If you want to use Torchlight.dev, enter your API token here to automatically enable it.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -20,6 +20,7 @@ This serves two purposes:
 - Use late static bindings to support overriding data collections file finding in https://github.com/hydephp/develop/pull/1717 (fixes https://github.com/hydephp/develop/issues/1716)
 - Method `Hyde::hasSiteUrl()` now returns false if the site URL is for localhost in https://github.com/hydephp/develop/pull/1726
 - Method `Hyde::url()` will now return a relative URL instead of throwing an exception when supplied a path even if the site URL is not set in https://github.com/hydephp/develop/pull/1726
+- Updated the `.env.example` file to contain more details on the site URL setting's usages in https://github.com/hydephp/develop/pull/1746
 
 ### Deprecated
 - for soon-to-be removed features.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# If you have a domain, you should set the URL here so that permalinks can be generated. You can also set it in the config/hyde.php file.`
	`1`	`+# If you have a domain, you should set the URL here so that sitemaps, RSS feeds, and permalinks can be generated. You can also set it in the config/hyde.php file.`
`2`	`2`	`SITE_URL=http://localhost`
`3`	`3`
`4`	`4`	`# If you want to use Torchlight.dev, enter your API token here to automatically enable it.`