Merge pull request #566 from hydephp/develop

HydePHP v1.0.0 - Release Candidate Five

README.md

@@ -8,7 +8,9 @@
 [![Test Coverage](https://codecov.io/gh/hydephp/develop/branch/master/graph/badge.svg?token=G6N2161TOT)](https://codecov.io/gh/hydephp/develop)
 [![Test Suite](https://github.com/hydephp/develop/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/hydephp/develop/actions/workflows/continuous-integration.yml)
 
+
 ## About
+
 HydePHP is a content-first Laravel-powered Static Site Builder that allows you to create static HTML pages, blog posts, and documentation sites using Markdown.
 Hyde is all about letting you get started quickly by giving you a full-featured frontend starter kit, while also giving you the power and freedom of doing things the way you want to.
 
@@ -29,12 +31,6 @@ Hyde has already been featured in the [Laravel News Podcast](https://laravel-new
 - [HydePHP/Hydefront](https://github.com/hydephp/hydefront) - The Hyde frontend assets. Extracted from the HydePHP/Framework repo to improve testing and allow for easier deployment using a CDN.
 
 
-## ⚠ Beta Software Warning
-Heads up! HydePHP is very new and currently in beta. Please report any bugs and issues in the appropriate issue tracker. Versions in the 0.x series are not stable and may change at any time. No backwards compatibility guarantees are made and there will be breaking changes without notice.
-
-Please wait until v1.0 for production use and remember to back up your source files before updating (use Git!).
-See https://hydephp.com/docs/master/updating-hyde for the upgrade guide.
-
 ## Resources
 
 ### Changelog

SECURITY.md

@@ -2,27 +2,19 @@
 
 ## Supported Versions
 
-### Hyde is currently in Beta and has no supported versions.
+These are the version ranges of HydePHP, and their support status. We follow [Semantic Versioning](https://semver.org), and you can read about our [Backwards Compatability](https://github.com/hydephp/policies/blob/master/backwards-compatability.md) promise here.
 
-Versions in the 0.x series are not stable and may change at any time.
-No backwards compatibility guarantees are made and there will be breaking changes without notice.
-
-| Version | Supported | Classification            |
-|---------|-----------|---------------------------|
-| > 0.50  | :warning: | Beta (active development) |
-| < 0.50  | :x:       | Beta (legacy)             |
-| < 0.8   | :x:       | Alpha stage               |
-
-
-<!-- 
-| 5.1.x   | :white_check_mark: |
-| 5.0.x   | :x:                |
-| 4.0.x   | :white_check_mark: |
-| < 4.0   | :x:                | -->
+| Version | Supported          | Classification       |
+|---------|--------------------|----------------------|
+| 1.x     | :white_check_mark: | General Availability |
+| < 0.64  | :x:                | Beta (legacy)        |
+| < 0.50  | :x:                | Beta (legacy)        |
+| < 0.8   | :x:                | Alpha stage          |
 
 
 ## Reporting a Vulnerability
 
 If you discover a security vulnerability within this package, please send an e-mail to the creator, Caen De Silva, via caen@desilva.se.
+You can also report a vulnerability through GitHub on the [Security Advisory](https://github.com/hydephp/develop/security/advisories) page.
 
 All security vulnerabilities will be promptly addressed.

config/docs.php

@@ -78,7 +78,7 @@
     | Collaborative Source Editing Location
     |--------------------------------------------------------------------------
     |
-    | @see https://hydephp.com/docs/master/documentation-pages#automatic-edit-page-button
+    | @see https://hydephp.com/docs/1.x/documentation-pages#automatic-edit-page-button
     |
     | By adding a base URL here, Hyde will use it to create "edit source" links
     | to your documentation pages. Hyde expects this to be a GitHub path, but
@@ -102,7 +102,7 @@
     |--------------------------------------------------------------------------
     |
     | Hyde comes with an easy to use search feature for documentation pages.
-    | @see https://hydephp.com/docs/master/documentation-pages#search-feature
+    | @see https://hydephp.com/docs/1.x/documentation-pages#search-feature
     |
     */
 

config/hyde.php

@@ -287,7 +287,7 @@
     | You can disable it completely by changing the setting to `false`.
     |
     | To read about the many configuration options here, visit:
-    | https://hydephp.com/docs/master/customization#footer
+    | https://hydephp.com/docs/1.x/customization#footer
     |
     */
 

config/markdown.php

@@ -75,7 +75,7 @@
     | arbitrary PHP to run. But if your Markdown is trusted, try it out!
     |
     | To see the syntax and usage, see the documentation:
-    | @see https://hydephp.com/docs/master/advanced-markdown#blade-support
+    | @see https://hydephp.com/docs/1.x/advanced-markdown#blade-support
     |
     */
 

resources/views/homepages/welcome.blade.php

@@ -60,12 +60,12 @@ class="relative mt-2 text-transparent bg-clip-text bg-gradient-to-br logo-gradie
                     <span class="sr-only">Resources for getting started</span>
                     <ul class="flex flex-wrap justify-center list-none" style="padding: 0;">
                         <li>
-                            <a href="https://hydephp.com/docs/master" class="uppercase font-bold text-sm flex text-center m-2 mx-3">
+                            <a href="https://hydephp.com/docs/1.x" class="uppercase font-bold text-sm flex text-center m-2 mx-3">
                                 Documentation
                             </a>
                         </li>
                         <li>
-                            <a href="https://hydephp.com/docs/master/getting-started" class="uppercase font-bold text-sm flex text-center m-2 mx-3">
+                            <a href="https://hydephp.com/docs/1.x/getting-started" class="uppercase font-bold text-sm flex text-center m-2 mx-3">
                                 Getting Started
                             </a>
                         </li>

resources/views/layouts/styles.blade.php

@@ -12,7 +12,7 @@
 @if(config('hyde.use_play_cdn', false))
     <script src="https://cdn.tailwindcss.com?plugins=typography"></script>
     <script>tailwind.config = { {!! Asset::injectTailwindConfig() !!} }</script>
-    <script>console.warn('The HydePHP TailwindCSS Play CDN is enabled. This is for development purposes only and should not be used in production.', 'See https://hydephp.com/docs/master/managing-assets');</script>
+    <script>console.warn('The HydePHP TailwindCSS Play CDN is enabled. This is for development purposes only and should not be used in production.', 'See https://hydephp.com/docs/1.x/managing-assets');</script>
 @endif
 
 {{-- Add any extra styles to include after the others --}}

src/Console/Commands/ValidateCommand.php

@@ -23,7 +23,10 @@ class ValidateCommand extends Command
     protected $signature = 'validate';
 
     /** @var string */
-    protected $description = 'Run a series of tests to validate your setup and help you optimize your site.';
+    protected $description = 'Test and validate your project to optimize your site.';
+
+    /** @var string */
+    protected $help = 'Run a series of tests to validate your setup and help you optimize your site.';
 
     protected ValidationService $service;
 

src/Facades/Author.php

@@ -18,7 +18,7 @@ class Author
      * Construct a new Post Author. For Hyde to discover this author,
      * you must call this method from your hyde.php config file.
      *
-     * @see https://hydephp.com/docs/master/customization.html#authors
+     * @see https://hydephp.com/docs/1.x/customization.html#authors
      *
      * @param  string  $username  The username of the author. This is the key used to find authors in the config.
      * @param  string|null  $name  The optional display name of the author, leave blank to use the username.

src/Foundation/Concerns/HydeExtension.php

@@ -18,7 +18,7 @@
  * Before creating your extension, it will certainly be helpful if you first become familiar
  * with the basic internal architecture of HydePHP, as well as how the auto-discovery system functions.
  *
- * @link https://hydephp.com/docs/master/basic-architecture-concepts
+ * @link https://hydephp.com/docs/1.x/core-concepts
  *
  * It's important that your class is registered before the HydeKernel boots.
  * An excellent place for this is the 'register' method of your extensions service provider,

src/Foundation/HydeKernel.php

@@ -49,7 +49,7 @@ class HydeKernel implements SerializableContract
     use Serializable;
     use Macroable;
 
-    final public const VERSION = '1.0.0-RC.4';
+    final public const VERSION = '1.0.0-RC.5';
 
     protected static self $instance;
 

src/Pages/BladePage.php

@@ -12,10 +12,10 @@
  * Page class for Blade pages.
  *
  * Blade pages are stored in the _pages directory and using the .blade.php extension.
- * They will be compiled using the Laravel Blade engine the _site/ directory.
+ * They will be compiled using the Laravel Blade engine to the _site/ directory.
  *
- * @see https://hydephp.com/docs/master/static-pages#creating-blade-pages
- * @see https://laravel.com/docs/master/blade
+ * @see https://hydephp.com/docs/1.x/static-pages#creating-blade-pages
+ * @see https://laravel.com/docs/1.x/blade
  */
 class BladePage extends HydePage
 {

src/Pages/Concerns/BaseMarkdownPage.php

@@ -24,11 +24,13 @@ abstract class BaseMarkdownPage extends HydePage implements MarkdownDocumentCont
 
     public static string $fileExtension = '.md';
 
+    /** @inheritDoc */
     public static function make(string $identifier = '', FrontMatter|array $matter = [], Markdown|string $markdown = ''): static
     {
         return new static($identifier, $matter, $markdown);
     }
 
+    /** @inheritDoc */
     public function __construct(string $identifier = '', FrontMatter|array $matter = [], Markdown|string $markdown = '')
     {
         $this->markdown = $markdown instanceof Markdown ? $markdown : new Markdown($markdown);