Skip to content

Commit 5a3ce65

Browse files
committed
Improve documentation v2
1 parent d9553be commit 5a3ce65

File tree

8 files changed

+14
-14
lines changed

8 files changed

+14
-14
lines changed

docs/basic-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,4 @@ process that the package can simplify for you once you read the documentation.
6565
The goal of the examples are to show that even without dwelling too much into the ins and out
6666
of the package you can easily and quickly parse or serialize compliant fields in PHP.
6767

68-
← [Intro](../index) | [Parsing and Serializing](../parsing-serializing) →
68+
← [Intro](index) | [Parsing and Serializing](parsing-serializing) →

docs/containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,4 +456,4 @@ Item::new($cache->name)
456456
->when(null !== $cache->detail, fn (Item $item) => $item->appendParameter('detail', $cache->detail));
457457
```
458458

459-
← [Accessing Field Values](../field-values) | [Validation](../validation) →
459+
← [Accessing Field Values](field-values) | [Validation](validation) →

docs/extensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,4 @@ To show how this can be achieved you can check the codebase from [HTTP Cache Sta
101101
which uses the interface. Of note by using this interface you can completely hide the presence of
102102
this package to your end users if needed.
103103

104-
← [Validation](../validation) | [Upgrading to v2.0](../migration) →
104+
← [Validation](validation) | [Upgrading to v2.0](migration) →

docs/field-values.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,4 +196,4 @@ By default, you can access the member `Item` of a parameters using the following
196196
It is possible to alter and modify the `Parameters` attached to an `Item` but this will be explored in
197197
the next section about the containers.
198198

199-
← [Parsing and Serializing](../parsing-serializing) | [Containers](../containers) →
199+
← [Parsing and Serializing](parsing-serializing) | [Containers](containers) →

docs/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ composer require bakame/http-structured-fields:^2.0
5454

5555
## Using the package
5656

57-
- [Basic usage](../basic-usage)
58-
- [Parsing and Serializing](../parsing-serializing)
59-
- [Accessing The Field Values](../field-values)
60-
- [Working with The Containers](../containers)
61-
- [Structured Field Validation](../validation)
62-
- [Interacting with the PHP Ecosystem](../extensions)
63-
- [Upgrading from 1.x to 2.0](../migration)
57+
- [Basic usage](basic-usage)
58+
- [Parsing and Serializing](parsing-serializing)
59+
- [Accessing The Field Values](field-values)
60+
- [Working with The Containers](containers)
61+
- [Structured Field Validation](validation)
62+
- [Interacting with the PHP Ecosystem](extensions)
63+
- [Upgrading from 1.x to 2.0](migration)

docs/migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,4 +150,4 @@ OuterList::fromPairs([
150150
> [!NOTE]
151151
> The v1 syntax is still supported.
152152
153-
← [Extending the package functionalities](../extensions) | [Intro](../index) →
153+
← [Extending the package functionalities](extensions) | [Intro](index) →

docs/parsing-serializing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,4 +165,4 @@ The `toHttpValue` method applies by default all the normalizations recommended b
165165
> This is the mechanism used by the `DataType::serialize` method. Once the HTTP Structured
166166
> Field has been created, the method calls its `toHttpValue` method.
167167
168-
← [Basic Usage](../basic-usage) | [Accessing Field Values](../field-values) →
168+
← [Basic Usage](basic-usage) | [Accessing Field Values](field-values) →

docs/validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,4 +432,4 @@ class it becomes easier to reuse it to validate your data.
432432
433433
To show how this can be achieved you can check the codebase from [HTTP Cache Status](https://github.com/bakame-php/http-cache-status)
434434

435-
← [Containers](../containers) | [Extending the package functionalities](../extensions) →
435+
← [Containers](containers) | [Extending the package functionalities](extensions) →

0 commit comments

Comments
 (0)