Merge pull request #119 from defstudio/new-docs

new docs
defstudio · Apr 18, 2024 · 32bf304 · 32bf304
2 parents c5e1095 + 910e55f
commit 32bf304
Show file tree

Hide file tree

Showing 41 changed files with 59 additions and 30,920 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ it('can check model exists', function(){
 You can install the package via composer:
 
 ```bash
-composer require --dev defstudio/pest-plugin-laravel-expectations
+composer require --dev defstudio/pest-plugin-laravel-11.expectations
 ```
 
 The expectations added by this plugin are automatically loaded into Pest's expectation system. They can be used along other expectations.

diff --git a/docs/.env.example b/docs/.env.example
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/content/en/index.md → docs/0.index.md b/docs/content/en/index.md → docs/0.index.md
@@ -1,9 +1,7 @@
 ---
 title: 'Pest Laravel Expectations'
 menuTitle: 'Introduction'
-description: 'Laravel tailored @pestphp expectations for web artisans'
-position: 1
-fullscreen: true
+description: 'Laravel tailored @pestphp 11.expectations for web artisans'
 ---
 
 <img src="https://banners.beyondco.de/Pest%20Laravel%20Expectations.png?theme=light&packageManager=composer+require&packageName=--dev+defstudio%2Fpest-plugin-laravel-expectations&pattern=circuitBoard&style=style_2&description=Laravel+tailored+%40pestphp+expectations&md=1&showWatermark=0&fontSize=100px&images=https%3A%2F%2Flaravel.com%2Fimg%2Flogomark.min.svg" class="light-img" alt=""/>
@@ -13,22 +11,21 @@ fullscreen: true
 <a href="https://packagist.org/packages/defstudio/pest-plugin-laravel-expectations" target="_blank">
     <img style="display: inline-block; margin-top: 0.5em; margin-bottom: 0.5em" src="https://img.shields.io/packagist/v/defstudio/pest-plugin-laravel-expectations.svg?style=flat-square" alt="Latest Version on Packagist">
 </a>
-
 <a href="https://github.com/defstudio/pest-plugin-laravel-expectations/actions?query=workflow%3A%22Run+Tests%22+branch%3Amaster" target="_blank">
     <img style="display: inline-block; margin-top: 0.5em; margin-bottom: 0.5em" src="https://img.shields.io/github/actions/workflow/status/defstudio/pest-plugin-laravel-expectations/tests.yml?branch=master&label=tests" alt="GitHub Tests Action Status">
 </a>
-
 <a href="https://github.com/defstudio/pest-plugin-laravel-expectations/actions?query=workflow%3A%22Static+Analysis%22+branch%3Amaster" target="_blank">
     <img style="display: inline-block; margin-top: 0.5em; margin-bottom: 0.5em" src="https://img.shields.io/github/actions/workflow/status/defstudio/pest-plugin-laravel-expectations/static.yml?branch=master&label=code%20style" alt="GitHub Code Style Action Status">
 </a>
-
 <a href="https://packagist.org/packages/defstudio/pest-plugin-laravel-expectations" target="_blank">
     <img style="display: inline-block; margin-top: 0.5em; margin-bottom: 0.5em" src="https://img.shields.io/packagist/dt/defstudio/pest-plugin-laravel-expectations.svg?style=flat-square" alt="Total Downloads">
 </a>
-
 <a href="https://packagist.org/packages/defstudio/pest-plugin-laravel-expectations" target="_blank">
     <img style="display: inline-block; margin-top: 0.5em; margin-bottom: 0.5em" src="https://img.shields.io/packagist/l/defstudio/pest-plugin-laravel-expectations" alt="License">
 </a>
+<a href="https://twitter.com/FabioIvona?ref_src=twsrc%5Etfw" target="_blank">
+    <img style="display: inline-block; margin-top: 0.5em; margin-bottom: 0.5em" alt="Twitter Follow" src="https://img.shields.io/twitter/follow/FabioIvona?label=Follow&style=social">
+</a>
 
 
 #### Easily add Laravel specific expectations to your [Pest](https://pestphp.com) testing ecosystem
@@ -58,7 +55,7 @@ test('home is rendered', function () {
 });
 ```
 
-Get the full source code at [https://github.com/defstudio/pest-plugin-laravel-expectations](https://github.com/defstudio/pest-plugin-laravel-expectations)
+[replace:full-source-code]
 
 
-This plugin is powered by [def:studio](https://github.com/defstudio)
+[replace:powered-by]
diff --git a/docs/1.about-us.md b/docs/1.about-us.md
@@ -0,0 +1 @@
+[replace:about-us]
diff --git a/...content/en/expectations/authentication.md → docs/11.expectations/1.authentication.md b/...content/en/expectations/authentication.md → docs/11.expectations/1.authentication.md
@@ -1,10 +1,6 @@
 ---
 title: Authentication Expectations
 menuTitle: Authentication
-description: ''
-category: 'Expectations'
-fullscreen: false
-position: 10
 ---
 
 ### `toBeAbleTo()`

diff --git a/docs/content/en/expectations/collections.md → docs/11.expectations/2.collections.md b/docs/content/en/expectations/collections.md → docs/11.expectations/2.collections.md
@@ -1,10 +1,6 @@
 ---
 title: Collections Expectations
 menuTitle: Collections
-description: ''
-category: 'Expectations'
-fullscreen: false
-position: 10
 ---
 
 ### `toBeCollection()`

diff --git a/docs/content/en/expectations/database.md → docs/11.expectations/3.database.md b/docs/content/en/expectations/database.md → docs/11.expectations/3.database.md
@@ -1,10 +1,6 @@
 ---
 title: Database Expectations
 menuTitle: Database
-description: ''
-category: 'Expectations'
-fullscreen: false
-position: 10
 ---
 
 ### `toBeInDatabase()`

diff --git a/docs/content/en/expectations/exceptions.md → docs/11.expectations/4.exceptions.md b/docs/content/en/expectations/exceptions.md → docs/11.expectations/4.exceptions.md
@@ -1,10 +1,6 @@
 ---
 title: Exceptions Expectations
 menuTitle: Exceptions
-description: ''
-category: 'Expectations'
-fullscreen: false
-position: 10
 ---
 
 ### `toThrowValidationException()` (available from v2, still with v1? Upgrade!)

diff --git a/docs/content/en/expectations/models.md → docs/11.expectations/5.models.md b/docs/content/en/expectations/models.md → docs/11.expectations/5.models.md
@@ -1,10 +1,6 @@
 ---
 title: Models Expectations
 menuTitle: Models
-description: ''
-category: 'Expectations'
-fullscreen: false
-position: 10
 ---
 
 ### `toBe()` (available from v2, still with v1? Upgrade!)

diff --git a/docs/content/en/expectations/responses.md → docs/11.expectations/6.responses.md b/docs/content/en/expectations/responses.md → docs/11.expectations/6.responses.md
@@ -1,10 +1,6 @@
 ---
 title: Responses Expectations
 menuTitle: Responses
-description: ''
-category: 'Expectations'
-fullscreen: false
-position: 10
 ---
 
 <alert type="info">**Note: this plugin wraps Responses to TestResponse, so expectations in this page can be used both with get()/post() calls and with object returned from response() helpers.</alert>

diff --git a/docs/content/en/expectations/storage.md → docs/11.expectations/7.storage.md b/docs/content/en/expectations/storage.md → docs/11.expectations/7.storage.md
@@ -1,10 +1,6 @@
 ---
 title: Storage Expectations
 menuTitle: Storage
-description: ''
-category: 'Expectations'
-fullscreen: false
-position: 10
 ---
 
 ### `toExistInStorage()`

diff --git a/docs/content/en/expectations/time.md → docs/11.expectations/8.time.md b/docs/content/en/expectations/time.md → docs/11.expectations/8.time.md
@@ -1,10 +1,6 @@
 ---
 title: Time Expectations
 menuTitle: Time
-description: ''
-category: 'Expectations'
-fullscreen: false
-position: 10
 ---
 
 ### `toBeAfter()`

diff --git a/docs/content/en/expectations/views.md → docs/11.expectations/9.views.md b/docs/content/en/expectations/views.md → docs/11.expectations/9.views.md
@@ -1,10 +1,6 @@
 ---
 title: Views Expectations
 menuTitle: Views
-description: ''
-category: 'Expectations'
-fullscreen: false
-position: 10
 ---
 
 ### `toBeView()`

diff --git a/docs/content/en/developers/contribute.md → docs/12.community/1.contributing.md b/docs/content/en/developers/contribute.md → docs/12.community/1.contributing.md
@@ -1,9 +1,5 @@
 ---
 title: Contribute
-description: ''
-category: 'Developers'
-fullscreen: true
-position: 20
 ---
 
 Contributions are welcome, and are accepted via pull requests.
@@ -24,3 +20,47 @@ Please review these guidelines before submitting any pull requests.
 * Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
 * You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts.
 * Please remember that we follow [SemVer](http://semver.org/).
+
+## Setup
+
+1. Fork the [main repository](https://github.com/defstudio/pest-plugin-laravel-expectations) by clicking the **Fork** button
+
+2. Clone your forked project to your development machine
+```bash
+git clone https://github.com/{your-github-name}/pest-plugin-laravel-11.expectations
+```
+
+3. Create a new branch
+```bash
+git checkout -b my-awesome-feature
+```
+
+4. Install the dev dependencies:
+```bash
+composer install
+```
+
+## Test your code
+
+## Lint
+
+Lint your code to ensure it fulfills our package styling standards:
+```bash
+composer lint
+```
+## Tests
+
+Run all tests:
+```bash
+composer test
+```
+
+Check types:
+```bash
+composer test:types
+```
+
+Unit tests:
+```bash
+composer test:unit
+```
diff --git a/docs/12.community/2.releases.md b/docs/12.community/2.releases.md
@@ -0,0 +1 @@
+[replace:releases]
diff --git a/docs/12.community/3.changelog.md b/docs/12.community/3.changelog.md
@@ -0,0 +1 @@
+[replace:changelog]
diff --git a/docs/content/en/installation.md → docs/2.installation.md b/docs/content/en/installation.md → docs/2.installation.md
@@ -1,12 +1,10 @@
 ---
 title: Installation & Configuration
 menuTitle: 'Installation'
-description: ''
-position: 2
-fullscreen: true
 ---
 
-<alert type="info">**Note:** This plugin assumes you already have a working [Pest](https://pestphp.com) test suite in your Laravel project.</alert>
+> [!Note]
+> This plugin assumes you already have a working [Pest](https://pestphp.com) test suite in your Laravel project.
 
 
 You can install the package via composer:

diff --git a/docs/content/en/autocompletion.md → docs/3.autocompletion.md b/docs/content/en/autocompletion.md → docs/3.autocompletion.md
@@ -1,16 +1,13 @@
 ---
 title: Autocompletion
 menuTitle: 'Autocompletion'
-description: ''
-position: 3
-fullscreen: true
 ---
 
 ## PhpStorm Autocompletion
 
 For PhpStorm users, a nice Plugin has been developed by [Oliver Nybroe](https://github.com/olivernybroe). It adds full autocompletion to ours Laravel Expectations, it is worth to take a look: [https://github.com/pestphp/pest-intellij](https://github.com/pestphp/pest-intellij)
 
-![](https://raw.githubusercontent.com/defstudio/pest-plugin-laravel-expectations-docs/main/static/docs/phpstorm-autocompletion.png "PhpStorm Autocompletion")
+![PhpStorm Autocompletion](/img/phpstorm-autocompletion.png)
 
 ## Visual Studio Code Autocompletion
 

diff --git a/docs/4.issues.md b/docs/4.issues.md
@@ -0,0 +1 @@
+[replace:issues]
diff --git a/docs/5.support-us.md b/docs/5.support-us.md
@@ -0,0 +1 @@
+[replace:support-us]
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/content/en/about-us.md b/docs/content/en/about-us.md