Skip to content

Commit bbf867f

Browse files
authored
Add more version updates to release notes
Updated release notes to reflect new features, improvements, and breaking changes.
1 parent 1640f17 commit bbf867f

File tree

1 file changed

+39
-7
lines changed

1 file changed

+39
-7
lines changed

RELEASE_NOTES.md

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ We've replaced Laravel Mix with Vite for a faster, more modern development exper
1414
- **Simplified build command**: Use `npm run build` instead of `npm run prod`
1515
- **Vite facade** for seamless Blade template integration
1616
- **Optimized asset serving** through the realtime compiler
17+
- **Hyde Vite plugin** for enhanced integration
1718

1819
### 🎨 Enhanced Asset Management System
1920

@@ -32,6 +33,7 @@ The navigation system has been completely rewritten for maximum flexibility:
3233
- **Improved Routes facade** with Laravel-consistent naming conventions
3334
- **Natural priority ordering** using numeric prefixes in filenames
3435
- **Enhanced sidebar management** with better organization options
36+
- **Navigation config builder class** for simplified configuration
3537

3638
### 📝 Improved Documentation Features
3739

@@ -41,6 +43,7 @@ Documentation pages now benefit from several enhancements:
4143
- **Custom heading renderer** with improved permalink handling
4244
- **Colored blockquotes** using Tailwind CSS classes
4345
- **Smart natural language processing** for search headings
46+
- **Dynamic source file links** in Markdown documents
4447

4548
### 🎯 Better Developer Experience
4649

@@ -50,6 +53,8 @@ Numerous quality-of-life improvements for developers:
5053
- **Tailwind CSS v4** with automated upgrade tools
5154
- **Enhanced data collections** with syntax validation
5255
- **Improved error messages** with clearer exception handling
56+
- **Interactive publish:views command** on Unix systems
57+
- **Extension callbacks** with `booting()` and `booted()` methods
5358

5459
## Breaking Changes & Upgrade Guide
5560

@@ -158,6 +163,8 @@ Key changes:
158163
- `Author::get()` returns `null` if not found (previously created new instance)
159164
- Usernames are automatically normalized (lowercase, underscores for spaces)
160165
- Authors support biographies, avatars, and social media links
166+
- A new `Hyde::authors()` method provides access to all site authors
167+
- Authors can be configured via YAML
161168

162169
### Medium Impact Changes
163170

@@ -191,6 +198,14 @@ $route = Routes::find('route-name'); // Returns null if not found
191198
$route = Routes::get('route-name'); // Throws exception
192199
```
193200

201+
#### DataCollection API
202+
203+
- Class renamed from `DataCollections` to `DataCollection`
204+
- Syntax validation now throws `ParseException` for malformed files
205+
- Empty data files are no longer allowed
206+
- Directory creation is no longer automatic
207+
- The `route` function now throws `RouteNotFoundException` if route not found
208+
194209
### Low Impact Changes
195210

196211
#### Includes Facade Return Types
@@ -207,12 +222,16 @@ Methods now return `HtmlString` objects:
207222

208223
⚠️ **Security Note:** Output is no longer escaped by default. Use `{{ e(Includes::html('foo')) }}` for user-generated content.
209224

210-
#### DataCollection API
225+
#### Documentation Search Generation
211226

212-
- Class renamed from `DataCollections` to `DataCollection`
213-
- Syntax validation now throws `ParseException` for malformed files
214-
- Empty data files are no longer allowed
215-
- Directory creation is no longer automatic
227+
The documentation search page is now generated as an `InMemoryPage` instead of a post-build task, meaning it appears in the dashboard and route list.
228+
229+
#### Sidebar Configuration
230+
231+
Documentation sidebar configuration has been reorganized:
232+
- `docs.sidebar_order``docs.sidebar.order`
233+
- `docs.table_of_contents``docs.sidebar.table_of_contents`
234+
- `docs.sidebar_group_labels``docs.sidebar.labels`
216235

217236
## New Features
218237

@@ -222,20 +241,24 @@ Methods now return `HtmlString` objects:
222241
- **Date prefixes in filenames** for automatic publishing dates
223242
- **Rich markup data** with BlogPosting Schema.org type
224243
- **Author collections** accessible via `Hyde::authors()`
244+
- **Custom posts support** in blog feed component
225245

226246
### Improved Build System
227247

228248
- **Vite integration** with HMR support in realtime compiler
229249
- **Smart asset compilation** - app.js only compiles when needed
230250
- **Environment variable support** for saving previews
231251
- **Grouped progress bars** for InMemoryPage instances
252+
- **Media asset transfers** via dedicated build task
232253

233254
### Developer Tools
234255

235256
- **Interactive publish:views command** on Unix systems
236257
- **Custom HydeSearch.js** support for search customization
237258
- **Extension callbacks** with `booting()` and `booted()` methods
238259
- **Dynamic source file links** in Markdown documents
260+
- **Feature::fromName()** enum helper
261+
- **Filesystem::ensureParentDirectoryExists()** helper method
239262

240263
## Package Updates
241264

@@ -278,6 +301,8 @@ Methods now return `HtmlString` objects:
278301
- [ ] Test site menus for correct ordering and appearance
279302
- [ ] Verify media assets are loading correctly
280303
- [ ] Check that all DataCollection files have valid syntax
304+
- [ ] Update sidebar configuration structure in `config/docs.php`
305+
- [ ] Review Includes facade usage for security implications
281306

282307
## Removed Features
283308

@@ -289,13 +314,20 @@ Methods now return `HtmlString` objects:
289314

290315
### Build Commands
291316
- `npm run prod` - replaced by `npm run build`
292-
- `--run-dev` and `--run-prod` flags - replaced by `--run-vite`
317+
- `--run-dev` and `--run-prod` flags - replaced by `--vite`
318+
- `--run-prettier` flag - Prettier dependency removed
293319

294320
### Configuration Options
295321
- `hyde.hydefront_version` and `hyde.hydefront_cdn_url` - now handled automatically
296322
- `hyde.enable_cache_busting` - renamed to `hyde.cache_busting`
297323
- `hyde.navigation.subdirectories` - renamed to `hyde.navigation.subdirectory_display`
298324

325+
### Components and Files
326+
- `hyde.css` from HydeFront - all styles now in `app.css`
327+
- `table-of-contents.css`, `heading-permalinks.css`, `blockquotes.css` - styles now use Tailwind
328+
- `.torchlight-enabled` CSS class
329+
- `<x-hyde::docs.search-input />` and `<x-hyde::docs.search-scripts />` components - replaced by `<x-hyde::docs.hyde-search />`
330+
299331
## Support & Resources
300332

301333
- **Documentation**: [https://hydephp.com/docs/2.x](https://hydephp.com/docs/2.x)
@@ -305,4 +337,4 @@ Methods now return `HtmlString` objects:
305337

306338
---
307339

308-
For the complete changelog with all pull request references, see the [full changelog](https://github.com/hydephp/develop/releases/tag/v2.0.0).
340+
For the complete changelog with all pull request references, see the [full changelog](https://github.com/hydephp/develop/releases/tag/v2.0.0).

0 commit comments

Comments
 (0)