Skip to content

Commit ed3d39a

Browse files
committed
Update documentation to reflect PHP 8.3 support and adjust GitHub links
1 parent 066c9c8 commit ed3d39a

4 files changed

Lines changed: 23 additions & 16 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export default defineConfig({
5151
"@type": "SoftwareApplication",
5252
"name": "Fetch PHP",
5353
"applicationCategory": "DeveloperApplication",
54-
"operatingSystem": "PHP 8.1+",
54+
"operatingSystem": "PHP 8.3+",
5555
"offers": {
5656
"@type": "Offer",
5757
"price": "0.00",
@@ -81,7 +81,7 @@ export default defineConfig({
8181
{ text: 'Guide', link: '/guide/' },
8282
{ text: 'API Reference', link: '/api/' },
8383
{ text: 'Examples', link: '/examples/' },
84-
{ text: 'Changelog', link: 'https://github.com/Thavarshan/fetch-php/blob/main/CHANGELOG.md' }
84+
{ text: 'Changelog', link: 'https://github.com/jerome/fetch-php/blob/main/CHANGELOG.md' }
8585
],
8686

8787
// Keep your existing sidebar structure
@@ -169,7 +169,7 @@ export default defineConfig({
169169

170170
// Social links (keeping your GitHub link)
171171
socialLinks: [
172-
{ icon: 'github', link: 'https://github.com/Thavarshan/fetch-php' }
172+
{ icon: 'github', link: 'https://github.com/jerome/fetch-php' }
173173
],
174174

175175
// Footer content with additional keywords naturally included
@@ -198,7 +198,7 @@ export default defineConfig({
198198

199199
// Add edit link to encourage contributions (helps with engagement metrics)
200200
editLink: {
201-
pattern: 'https://github.com/Thavarshan/fetch-php/edit/main/docs/:path',
201+
pattern: 'https://github.com/jerome/fetch-php/edit/main/docs/:path',
202202
text: 'Edit this page on GitHub'
203203
},
204204

docs/guide/installation.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,40 @@ title: Installation
33
description: How to install the Fetch HTTP package in your PHP project
44
---
55

6-
**# Installation**
6+
# Installation
77

88
The Fetch HTTP package can be installed using Composer, the PHP dependency manager.
99

10-
**## Requirements**
10+
## Requirements
1111

1212
- PHP 8.3 or higher
1313
- Composer
1414

15-
**## Install via Composer**
15+
## Install via Composer
1616

17-
**### 1. Add to your project**
17+
### 1. Add to your project
1818

1919
```bash
2020
composer require jerome/fetch-php
2121
```
2222

23-
**### 2. Update your autoloader**
23+
### 2. Update your autoloader
2424

2525
If you haven't already done so, make sure you include the Composer autoloader in your project:
2626

2727
```php
2828
require __DIR__ . '/vendor/autoload.php';
2929
```
3030

31-
**## Manual Installation (Not Recommended)**
31+
## Manual Installation (Not Recommended)
3232

3333
While we strongly recommend using Composer, you can also manually download the package and include it in your project:
3434

35-
1. Download the latest release from [GitHub](https://github.com/Thavarshan/fetch-php/releases)
35+
1. Download the latest release from [GitHub](https://github.com/jerome/fetch-php/releases)
3636
2. Extract the files into your project directory
3737
3. Set up your own autoloading system or include files manually
3838

39-
**## Verifying Installation**
39+
## Verifying Installation
4040

4141
After installation, you can verify that everything is working correctly by creating a simple script:
4242

@@ -57,7 +57,7 @@ if ($response->successful()) {
5757
}
5858
```
5959

60-
**## Testing Different Response Methods**
60+
## Testing Different Response Methods
6161

6262
You can also test some of the enhanced response methods:
6363

@@ -90,6 +90,6 @@ if ($response->isOk()) {
9090
}
9191
```
9292

93-
**## Next Steps**
93+
## Next Steps
9494

9595
After installation, check out the [Quickstart](/guide/quickstart) guide to begin using the Fetch HTTP package.

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ hero:
3434
link: /guide/quickstart
3535
- theme: alt
3636
text: View on GitHub
37-
link: https://github.com/Thavarshan/fetch-php
37+
link: https://github.com/jerome/fetch-php
3838

3939
# Your existing features section (unchanged)
4040
features:
@@ -169,5 +169,5 @@ Absolutely. Fetch PHP provides an elegant API for file uploads, supporting both
169169
Yes. Fetch PHP is built on top of Guzzle, one of the most battle-tested HTTP clients in the PHP ecosystem, while providing a more modern developer experience.
170170

171171
<div class="custom-block warning">
172-
<p>Having trouble? <a href="https://github.com/Thavarshan/fetch-php/issues">Open an issue</a> on our GitHub repository.</p>
172+
<p>Having trouble? <a href="https://github.com/jerome/fetch-php/issues">Open an issue</a> on our GitHub repository.</p>
173173
</div>

docs/map.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Documentation Structure
3+
description: Overview of the documentation structure and file organization for the Fetch PHP project
4+
---
5+
6+
# Documentation Structure
7+
18
docs/
29
├── .vitepress/
310
│ ├── config.js # VitePress configuration

0 commit comments

Comments
 (0)