Skip to content

Commit 211c95f

Browse files
committed
Improve documentation structure
1 parent bc1252f commit 211c95f

File tree

9 files changed

+42
-5
lines changed

9 files changed

+42
-5
lines changed

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,8 @@ composer require bakame/http-structured-fields
3636

3737
## Documentation
3838

39-
> [!WARNING]
40-
> The documentation for v2 is still not fully finished. Please refers to [version 1.x](https://github.com/bakame-php/http-structured-fields/tree/1.x)
41-
> for the most recent and stable documentation.
42-
43-
The documentation for v2 is a [work in progress you can read here](/docs/00-intro.md)
39+
- The documentation for [version 2.x](/docs/00-intro.md) is a **work in progress**
40+
- The documentation for [version 1.x](https://github.com/bakame-php/http-structured-fields/tree/1.x) for the current stable version.
4441

4542
## Contributing
4643

docs/00-intro.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Introduction
3+
order: 1
4+
---
5+
16
# Introduction
27

38
`bakame/http-structured-fields` is a framework-agnostic PHP library that allows you to parse, serialize,

docs/01-basic-usage.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Basic usage
3+
order: 2
4+
---
5+
16
# Basic Usage
27

38
## Parsing the Field

docs/02-parsing-serializing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Parsing and Serializing HTTP Fields
3+
order: 3
4+
---
5+
16
# Parsing and Serializing HTTP Fields
27

38
## Parsing fields

docs/03-value-types.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: HTTP Fields value types
3+
order: 4
4+
---
5+
16
# Structured Fields Values
27

38
## Value type conversion to PHP

docs/04-item.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: The Structured Field Item Data Type
3+
order: 5
4+
---
5+
16
# The Item Data Type
27

38
This is the structure from which you will be able to access the actual field content.

docs/05-containers.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: The Structured Field containers Data Types
3+
order: 6
4+
---
5+
16
# Containers
27

38
While building or updating a Bare Item is straightforward, doing the same with the structured field

docs/06-validation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Structured Field validation
3+
order: 7
4+
---
5+
16
# Validation
27

38
When it comes to make sure about the incoming data the package provides a simple approach around validation,

docs/07-extensions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Interacting with PHP ecosystem
3+
order: 8
4+
---
5+
16
# Interacting with PHP ecosystem
27

38
All Datatypes expose the `Stringable` interface while it is recommended to use

0 commit comments

Comments
 (0)