Skip to content

Commit

Permalink
Improve documentation structure
Browse files Browse the repository at this point in the history
  • Loading branch information
nyamsprod committed Nov 18, 2024
1 parent bc1252f commit 211c95f
Show file tree
Hide file tree
Showing 9 changed files with 42 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,8 @@ composer require bakame/http-structured-fields

## Documentation

> [!WARNING]
> 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)
> for the most recent and stable documentation.
The documentation for v2 is a [work in progress you can read here](/docs/00-intro.md)
- The documentation for [version 2.x](/docs/00-intro.md) is a **work in progress**
- The documentation for [version 1.x](https://github.com/bakame-php/http-structured-fields/tree/1.x) for the current stable version.

## Contributing

Expand Down
5 changes: 5 additions & 0 deletions docs/00-intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Introduction
order: 1
---

# Introduction

`bakame/http-structured-fields` is a framework-agnostic PHP library that allows you to parse, serialize,
Expand Down
5 changes: 5 additions & 0 deletions docs/01-basic-usage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Basic usage
order: 2
---

# Basic Usage

## Parsing the Field
Expand Down
5 changes: 5 additions & 0 deletions docs/02-parsing-serializing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Parsing and Serializing HTTP Fields
order: 3
---

# Parsing and Serializing HTTP Fields

## Parsing fields
Expand Down
5 changes: 5 additions & 0 deletions docs/03-value-types.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: HTTP Fields value types
order: 4
---

# Structured Fields Values

## Value type conversion to PHP
Expand Down
5 changes: 5 additions & 0 deletions docs/04-item.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: The Structured Field Item Data Type
order: 5
---

# The Item Data Type

This is the structure from which you will be able to access the actual field content.
Expand Down
5 changes: 5 additions & 0 deletions docs/05-containers.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: The Structured Field containers Data Types
order: 6
---

# Containers

While building or updating a Bare Item is straightforward, doing the same with the structured field
Expand Down
5 changes: 5 additions & 0 deletions docs/06-validation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Structured Field validation
order: 7
---

# Validation

When it comes to make sure about the incoming data the package provides a simple approach around validation,
Expand Down
5 changes: 5 additions & 0 deletions docs/07-extensions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Interacting with PHP ecosystem
order: 8
---

# Interacting with PHP ecosystem

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

0 comments on commit 211c95f

Please sign in to comment.