Improve documentation v2

Author: nyamsprod

README.md

@@ -36,8 +36,7 @@ composer require bakame/http-structured-fields
 
 ## Documentation
 
-- The documentation for [version 2.x](/docs/00-intro.md) for **the upcoming v2 release**
-- The documentation for [version 1.x](https://github.com/bakame-php/http-structured-fields/tree/1.x) for the current stable version.
+- The documentation for **the upcoming [version 2.x](https://bakame-php.github.io/http-structured-fields/) release**
 
 ## Contributing
 

docs/01-basic-usage.md

@@ -65,4 +65,4 @@ process that the package can simplify for you once you read the documentation.
 The goal of the examples are to show that even without dwelling too much into the ins and out
 of the package you can easily and quickly parse or serialize compliant fields in PHP.
 
-← [Intro](00-intro.md)  |  [Parsing and Serializing](02-parsing-serializing.md) →
+← [Intro](index)  |  [Parsing and Serializing](02-parsing-serializing.md) →

docs/04-containers.md

@@ -456,4 +456,4 @@ Item::new($cache->name)
     ->when(null !== $cache->detail, fn (Item $item) => $item->appendParameter('detail', $cache->detail));
 ```
 
-← [Accessing Field Values](03-field-values.md)  |  [Validation](05-validation) →
+← [Accessing Field Values](03-field-values.md)  |  [Validation](05-validation.md) →

docs/05-validation.md

@@ -432,4 +432,4 @@ class it becomes easier to reuse it to validate your data.
 
 To show how this can be achieved you can check the codebase from [HTTP Cache Status](https://github.com/bakame-php/http-cache-status)
 
-← [Containers](04-containers.md)  | [Extending the package functionalities](07-extensions.md)
+← [Containers](04-containers)  | [Extending the package functionalities](06-extensions)

docs/07-extensions.md renamed to docs/06-extensions.md

@@ -101,4 +101,4 @@ To show how this can be achieved you can check the codebase from [HTTP Cache Sta
 which uses the interface. Of note by using this interface you can completely hide the presence of 
 this package to your end users if needed.
 
-← [Validation](05-validation.md)  | [Upgrading to v2.0](08-migration.md)
+← [Validation](05-validation.md)  | [Upgrading to v2.0](07-migration)

docs/08-migration.md renamed to docs/07-migration.md

@@ -150,4 +150,4 @@ OuterList::fromPairs([
 > [!NOTE]
 > The v1 syntax is still supported.
 
-← [Extending the package functionalities](07-extensions.md)  |  [Intro](00-intro.md) →
+← [Extending the package functionalities](06-extensions)  |  [Intro](index) →

docs/_config.yml

@@ -0,0 +1,8 @@
+---
+permalink: pretty
+remote_theme: pages-themes/minimal@v0.2.0
+plugins:
+    - jekyll-redirect-from
+    - jekyll-remote-theme # add this line to the plugins list if you already have one
+title: bakame/http-structured-fields
+description: is a framework-agnostic PHP library that allows you to parse, serialize, create, update and validate HTTP Structured Fields in PHP

docs/00-intro.md renamed to docs/index.md

@@ -59,5 +59,5 @@ composer require bakame/http-structured-fields:^2.0
 - [Accessing The Field Values](03-field-values.md)
 - [Working with The Containers](04-containers.md)
 - [Structured Field Validation](05-validation.md)
-- [Interacting with the PHP Ecosystem](07-extensions.md)
-- [Upgrading from 1.x to 2.0](08-migration.md)
+- [Interacting with the PHP Ecosystem](06-extensions)
+- [Upgrading from 1.x to 2.0](07-migration)

src/Type.php

@@ -11,8 +11,8 @@
  */
 enum Type: string
 {
-    public const MAXIMUM_INT = 999_999_999_999_999;
-    public const MAXIMUM_FLOAT = 999_999_999_999;
+    private const MAXIMUM_INT = 999_999_999_999_999;
+    private const MAXIMUM_FLOAT = 999_999_999_999;
 
     case Integer = 'integer';
     case Decimal = 'decimal';
@@ -45,7 +45,7 @@ public function isOneOf(mixed ...$other): bool
     /**
      * @throws SyntaxError if the value can not be resolved into a supported HTTP structured field data type
      */
-    public static function fromVariable(mixed $value): self
+    public static function fromVariable(Item|Token|DisplayString|Bytes|DateTimeInterface|int|float|bool|string $value): self
     {
         return self::tryFromVariable($value) ?? throw new SyntaxError(match (true) {
             $value instanceof DateTimeInterface => 'The integer representation of a date is limited to 15 digits for a HTTP structured field date type.',

tests/TypeTest.php

@@ -12,12 +12,6 @@
 
 final class TypeTest extends TestCase
 {
-    #[Test]
-    public function it_will_return_null_if_the_type_is_no_supported(): void
-    {
-        self::assertNull(Type::tryFromVariable([]));
-    }
-
     #[Test]
     public function it_will_return_false_if_the_type_is_valid_but_its_value_is_invalid(): void
     {
@@ -35,7 +29,7 @@ public function it_can_tell_the_item_type_from_a_value_instance(): void
     #[DataProvider('itemTypeProvider')]
     public function it_can_tell_the_item_type(mixed $value, Type $expectedType): void
     {
-        self::assertTrue($expectedType->equals(Type::fromVariable($value)));
+        self::assertTrue($expectedType->equals(Type::fromVariable($value))); /* @phpstan-ignore-line */
         self::assertTrue($expectedType->equals(Type::tryFromVariable($value)));
     }