Skip to content

Commit

Permalink
Simplify documentation codebase
Browse files Browse the repository at this point in the history
  • Loading branch information
nyamsprod committed Dec 4, 2024
1 parent c17a734 commit 42b23c9
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 23 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ composer require bakame/http-structured-fields

## Documentation

- The documentation for **the upcoming [version 2.x](https://bakame-php.github.io/http-structured-fields/) release**
- The documentation for **the upcoming [version 2.x](docs/) release**

## Contributing

Expand Down
8 changes: 0 additions & 8 deletions docs/_config.yml

This file was deleted.

2 changes: 1 addition & 1 deletion docs/01-basic-usage.md → docs/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](index) | [Parsing and Serializing](02-parsing-serializing.md) →
← [Intro](index) | [Parsing and Serializing](parsing-serializing) →
2 changes: 1 addition & 1 deletion docs/04-containers.md → docs/containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.md) →
← [Accessing Field Values](field-values) | [Validation](validation) →
2 changes: 1 addition & 1 deletion docs/06-extensions.md → docs/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](07-migration)
← [Validation](validation) | [Upgrading to v2.0](migration)
2 changes: 1 addition & 1 deletion docs/03-field-values.md → docs/field-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,4 +196,4 @@ By default, you can access the member `Item` of a parameters using the following
It is possible to alter and modify the `Parameters` attached to an `Item` but this will be explored in
the next section about the containers.

← [Parsing and Serializing](02-parsing-serializing.md) | [Containers](04-containers.md) →
← [Parsing and Serializing](parsing-serializing) | [Containers](containers) →
14 changes: 7 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ composer require bakame/http-structured-fields:^2.0

## Using the package

- [Basic usage](01-basic-usage.md)
- [Parsing and Serializing](02-parsing-serializing.md)
- [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](06-extensions)
- [Upgrading from 1.x to 2.0](07-migration)
- [Basic usage](basic-usage)
- [Parsing and Serializing](parsing-serializing)
- [Accessing The Field Values](field-values)
- [Working with The Containers](containers)
- [Structured Field Validation](validation)
- [Interacting with the PHP Ecosystem](extensions)
- [Upgrading from 1.x to 2.0](migration)
2 changes: 1 addition & 1 deletion docs/07-migration.md → docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,4 +150,4 @@ OuterList::fromPairs([
> [!NOTE]
> The v1 syntax is still supported.
← [Extending the package functionalities](06-extensions) | [Intro](index) →
← [Extending the package functionalities](extensions) | [Intro](index) →
Original file line number Diff line number Diff line change
Expand Up @@ -165,4 +165,4 @@ The `toHttpValue` method applies by default all the normalizations recommended b
> This is the mechanism used by the `DataType::serialize` method. Once the HTTP Structured
> Field has been created, the method calls its `toHttpValue` method.
← [Basic Usage](01-basic-usage.md) | [Accessing Field Values](03-field-values.md) →
← [Basic Usage](basic-usage) | [Accessing Field Values](field-values) →
2 changes: 1 addition & 1 deletion docs/05-validation.md → docs/validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) | [Extending the package functionalities](06-extensions)
← [Containers](containers) | [Extending the package functionalities](extensions)

0 comments on commit 42b23c9

Please sign in to comment.