Skip to content

Commit

Permalink
Merge pull request #1546 from hydephp/documentation-improvements
Browse files Browse the repository at this point in the history
Documentation improvements
  • Loading branch information
caendesilva committed Feb 11, 2024
2 parents 4233563 + a2a9a5f commit 3bb136e
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion config/hyde.php
Expand Up @@ -462,7 +462,7 @@
'build_manifest_path' => 'app/storage/framework/cache/build-manifest.json',

// Here you can specify HydeFront version and URL for when loading app.css from the CDN.
// Only change these if you know what you're doing as some versions may incompatible with your Hyde version.
// Only change these if you know what you're doing as some versions may be incompatible with your Hyde version.
'hydefront_version' => \Hyde\Framework\Services\AssetService::HYDEFRONT_VERSION,
'hydefront_cdn_url' => \Hyde\Framework\Services\AssetService::HYDEFRONT_CDN_URL,

Expand Down
2 changes: 1 addition & 1 deletion docs/creating-content/documentation-pages.md
Expand Up @@ -220,7 +220,7 @@ You can change this in the Docs configuration file. Tip: The header will link to
### Sidebar page order

To quickly arrange the order of items in the sidebar, you can reorder the page identifiers in the list and the links will be sorted in that order.
Link items without an entry here will have fall back to the default priority of 999, putting them last.
Link items without an entry here will fall back to the default priority of 999, putting them last.

```php
'sidebar_order' => [
Expand Down
4 changes: 2 additions & 2 deletions docs/digging-deeper/customization.md
Expand Up @@ -224,7 +224,7 @@ Learn more in the [Documentation Pages](documentation-pages) documentation.

## Additional Advanced Options

The following configuration options in the `confg/hyde.php` file are intended for advanced users and
The following configuration options in the `config/hyde.php` file are intended for advanced users and
should only be modified if you fully understand their impact. The code examples show the default values.

### `media_extensions`
Expand Down Expand Up @@ -272,7 +272,7 @@ Specifies the path where the build manifest should be saved, relative to the pro

These options allow you to specify the HydeFront version and CDN URL when loading `app.css` from the CDN.

Only change these if you know what you're doing as some versions may incompatible with your Hyde version.
Only change these if you know what you're doing as some versions may be incompatible with your Hyde version.

```php
// filepath config/hyde.php
Expand Down
2 changes: 1 addition & 1 deletion docs/digging-deeper/troubleshooting.md
Expand Up @@ -90,7 +90,7 @@ You can read more about some of these in the [Core Concepts](core-concepts#paths
| RSS feed not being generated | The RSS feed requires that you have set a site URL in the Hyde config or the `.env` file. Also check that you have blog posts, and that they are enabled. | Check your configuration files. | |
| Sitemap not being generated | The sitemap requires that you have set a site URL in the Hyde config or the `.env` file. | Check your configuration files. | |
| Unable to do literally anything | If everything is broken, you may be missing a Composer package or your configuration files could be messed up. | Run `composer install` and/or `composer update`. If you can run HydeCLI commands, update your configs with `php hyde publish:configs`, or copy them manually from GitHub or the vendor directory. |
| Namespaced Yaml config (``hyde.yml) not working | When using namedspaced Yaml configuration, you must begin the file with `hyde:`, even if you just want to use another file for example `docs:`. | Make sure the file starts with `hyde:` (You don't need to specify any options, as long as it's present). See [`#1475`](https://github.com/hydephp/develop/issues/1475) |
| Namespaced Yaml config (`hyde.yml`) not working | When using namespaced Yaml configuration, you must begin the file with `hyde:`, even if you just want to use another file for example `docs:`. | Make sure the file starts with `hyde:` (You don't need to specify any options, as long as it's present). See [`#1475`](https://github.com/hydephp/develop/issues/1475) |

### Extra troubleshooting information

Expand Down
2 changes: 1 addition & 1 deletion packages/framework/config/hyde.php
Expand Up @@ -462,7 +462,7 @@
'build_manifest_path' => 'app/storage/framework/cache/build-manifest.json',

// Here you can specify HydeFront version and URL for when loading app.css from the CDN.
// Only change these if you know what you're doing as some versions may incompatible with your Hyde version.
// Only change these if you know what you're doing as some versions may be incompatible with your Hyde version.
'hydefront_version' => \Hyde\Framework\Services\AssetService::HYDEFRONT_VERSION,
'hydefront_cdn_url' => \Hyde\Framework\Services\AssetService::HYDEFRONT_CDN_URL,

Expand Down

0 comments on commit 3bb136e

Please sign in to comment.