Skip to content

Commit

Permalink
Improve documentation v2
Browse files Browse the repository at this point in the history
  • Loading branch information
nyamsprod committed Dec 3, 2024
1 parent a7f5cb8 commit b818225
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 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](/docs/index) release**
- The documentation for **the upcoming [version 2.x](https://bakame-php.github.io/http-structured-fields/) release**

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion docs/05-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.md) | [Extending the package functionalities](07-extensions.md)
← [Containers](04-containers) | [Extending the package functionalities](06-extensions)
2 changes: 1 addition & 1 deletion docs/07-extensions.md → docs/06-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](08-migration.md)
← [Validation](05-validation.md) | [Upgrading to v2.0](07-migration)
2 changes: 1 addition & 1 deletion docs/08-migration.md → docs/07-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](07-extensions.md) | [Intro](index) →
← [Extending the package functionalities](06-extensions) | [Intro](index) →
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
permalink: pretty
remote_theme: pages-themes/hacker@v0.2.0
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
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit b818225

Please sign in to comment.