Skip to content

Commit 46abcfd

Browse files
committed
Manual proofreading
1 parent bbf867f commit 46abcfd

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

RELEASE_NOTES.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ HydePHP v2.0 represents a major evolution of the framework, introducing signific
1111
We've replaced Laravel Mix with Vite for a faster, more modern development experience:
1212
- **Instant Hot Module Replacement (HMR)** for real-time updates during development
1313
- **Direct asset compilation** into the `_media` folder for cleaner builds
14-
- **Simplified build command**: Use `npm run build` instead of `npm run prod`
14+
- **Updated build command**: Use `npm run build` instead of `npm run prod` (or `--vite` during the sit build)
1515
- **Vite facade** for seamless Blade template integration
1616
- **Optimized asset serving** through the realtime compiler
1717
- **Hyde Vite plugin** for enhanced integration
@@ -33,15 +33,14 @@ The navigation system has been completely rewritten for maximum flexibility:
3333
- **Improved Routes facade** with Laravel-consistent naming conventions
3434
- **Natural priority ordering** using numeric prefixes in filenames
3535
- **Enhanced sidebar management** with better organization options
36-
- **Navigation config builder class** for simplified configuration
3736

3837
### 📝 Improved Documentation Features
3938

4039
Documentation pages now benefit from several enhancements:
4140
- **Alpine.js-powered search** with customizable implementation
4241
- **Blade-based table of contents** that's 40x faster than before
4342
- **Custom heading renderer** with improved permalink handling
44-
- **Colored blockquotes** using Tailwind CSS classes
43+
- **Colored blockquotes** now using Tailwind CSS classes
4544
- **Smart natural language processing** for search headings
4645
- **Dynamic source file links** in Markdown documents
4746

@@ -60,7 +59,7 @@ Numerous quality-of-life improvements for developers:
6059

6160
### Prerequisites
6261

63-
Before upgrading, ensure your application is running HydePHP v1.6 or later, as this version includes helpers to ease the migration process.
62+
Before upgrading, ensure your application is running HydePHP v1.6 or later, as this version includes helpers to ease the migration process. It's ideal to use v1.8, if possible.
6463

6564
### High Impact Changes
6665

@@ -166,11 +165,13 @@ Key changes:
166165
- A new `Hyde::authors()` method provides access to all site authors
167166
- Authors can be configured via YAML
168167

168+
The way this system now works is that you first define authors in the config, Hyde the loads this during the booting process, and you can then access them using the get method.
169+
169170
### Medium Impact Changes
170171

171172
#### Asset API Updates
172173

173-
All asset methods now return `MediaFile` instances instead of strings:
174+
All asset methods now return `MediaFile` instances instead of strings. This instance can be cast to a string which will automatically resolve to a relative link at that time. You can also call helper methods on it. When using Blade templates, thanks to the Stringable implementation no change will happen.
174175

175176
```php
176177
// Methods renamed for clarity
@@ -256,8 +257,7 @@ Documentation sidebar configuration has been reorganized:
256257
- **Interactive publish:views command** on Unix systems
257258
- **Custom HydeSearch.js** support for search customization
258259
- **Extension callbacks** with `booting()` and `booted()` methods
259-
- **Dynamic source file links** in Markdown documents
260-
- **Feature::fromName()** enum helper
260+
- **Dynamic source file links** in Markdown documents (for example `[Home](/_pages/index.blade.php)`)
261261
- **Filesystem::ensureParentDirectoryExists()** helper method
262262

263263
## Package Updates
@@ -289,7 +289,7 @@ Documentation sidebar configuration has been reorganized:
289289

290290
## Migration Checklist
291291

292-
- [ ] Upgrade to HydePHP v1.6 before migrating to v2.0
292+
- [ ] Upgrade to HydePHP v1.6 (preferably v1.8) before migrating to v2.0
293293
- [ ] Run `npx @tailwindcss/upgrade` for Tailwind v4 migration
294294
- [ ] Update `config/hyde.php` features to use enum values
295295
- [ ] Update navigation configuration to array format
@@ -315,7 +315,7 @@ Documentation sidebar configuration has been reorganized:
315315
### Build Commands
316316
- `npm run prod` - replaced by `npm run build`
317317
- `--run-dev` and `--run-prod` flags - replaced by `--vite`
318-
- `--run-prettier` flag - Prettier dependency removed
318+
- `--run-prettier` flag and Prettier dependency removed
319319

320320
### Configuration Options
321321
- `hyde.hydefront_version` and `hyde.hydefront_cdn_url` - now handled automatically

0 commit comments

Comments
 (0)