Update docs

Author: shalvah

.scribe/.filemtimes

@@ -1,4 +1,4 @@
 # GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE.
 # Scribe uses this file to know when you change something manually in your docs.
-.scribe/index.md=1622334857
-.scribe/authentication.md=1622334857
+.scribe/index.md=1622336665
+.scribe/authentication.md=1622336665

.scribe/endpoints.cache/1.yaml

@@ -62,19 +62,19 @@ endpoints:
         name: description
         description: 'A longer description of your side project. The value must not be greater than 255 characters.'
         required: false
-        example: szzvblztjfkdcmbnyysgwaagmzzqsujuvpbfznqhdmixenuexclndzcqzufmzfuqiwccyiaskjwvgupofzwbgfpegblnuzsqqpbqgsgfgujnefakxbecccbmogvbydjszntyazlkgsgsuhzyqiedsqyvwgepiotomphpxrfgxkhgeqpwtjtnkguxdbmuwsscywbgmerhulfvznigtfezrgmmngkmltynhsenqenrgwhpklflyedqiwuhkcyy
+        example: fgjbfzbzhamascqffkukusyxpfhhnexibriqgoylogtkynblcsjszzfmuiyixsoborxcppjuwtwugoxonwehwavbbmbycmufnnqlatfoqoxlylkouuojexovacalpbjnuwnmbcbgnwqidmlgcgplkzzbf
         type: string
       url:
         name: url
         description: 'A url to your side project. The value must be a valid URL.'
         required: false
-        example: 'http://www.lemke.info/id-nihil-earum-minima-ea-quis-tempora.html'
+        example: 'http://www.bayer.org/architecto-laudantium-perferendis-doloribus-sint'
         type: string
       due_at:
         name: due_at
         description: 'Due date for the side project. The value must be a valid date. The value must be a valid date in the format Ymd. The value must be a date after <code>today</code>.'
         required: false
-        example: '2062-01-04'
+        example: '2112-08-03'
         type: string
     responses: []
     responseFields: []
@@ -105,7 +105,7 @@ endpoints:
     responses:
       -
         status: 200
-        content: '{"data":{"name":"voluptatem mollitia odit","description":"Atque molestiae soluta libero vitae pariatur at.","due_date":"20240222","owner":{"id":1,"name":"Pete","email":"[email protected]","email_verified_at":null,"created_at":"2021-05-29T22:53:05.000000Z","updated_at":"2021-05-29T22:53:05.000000Z"}}}'
+        content: '{"data":{"name":"omnis facere quia","description":"Porro atque exercitationem aspernatur doloribus reiciendis quo repellendus.","due_date":"20280807","owner":{"id":1,"name":"Pete","email":"[email protected]","email_verified_at":null,"created_at":"2021-05-29T22:53:05.000000Z","updated_at":"2021-05-29T22:53:05.000000Z"}}}'
         headers: []
         description: null
     responseFields: []
@@ -126,7 +126,7 @@ endpoints:
         name: id
         description: 'The ID of the side project.'
         required: true
-        example: 3
+        example: 4
         type: integer
     queryParameters: []
     bodyParameters: []
@@ -148,7 +148,7 @@ endpoints:
         name: id
         description: 'The ID of the side project.'
         required: true
-        example: 16
+        example: 6
         type: integer
     queryParameters: []
     bodyParameters: []

.scribe/endpoints.cache/2.yaml

@@ -21,19 +21,19 @@ endpoints:
         name: name
         description: 'The value must be at least 1 characters. The value must not be greater than 255 characters.'
         required: true
-        example: smwrfzagusffdunbvldexcnxwwlekvhhzuadousqjqlzhfjyrjieurdsegqxaadncagszmgajcaoasevirpdknbggkemhnvgupmxxqfwbfkkpitdcjcowrrajpflaltrcdwfnicxxibboaqtkqr
+        example: meinzggvhunivpobtwkftopruribdemrysmmuudebsbyazghwgwjlslewevcvocfftaryqiuqxlfbbyguukraxzd
         type: string
       email:
         name: email
         description: 'The value must be a valid email address.'
         required: true
-        example: lemke.jillian@example.com
+        example: shanahan.bridie@example.net
         type: string
       password:
         name: password
         description: ''
         required: true
-        example: nemo
+        example: magni
         type: string
     responses: []
     responseFields: []
@@ -55,14 +55,14 @@ endpoints:
         name: id
         description: 'The ID of the user.'
         required: true
-        example: 8
+        example: 4
         type: integer
     queryParameters: []
     bodyParameters: []
     responses:
       -
         status: 200
-        content: '{"data":{"id":6,"name":"Alvina Krajcik","email":"rhoda22@example.net","side_projects":[{"id":10,"name":"labore neque necessitatibus","description":"Et omnis occaecati aut ab porro est qui harum.","url":null,"due_at":"20250126","created_at":"2021-05-30T00:34:17.000000Z","updated_at":"2021-05-30T00:34:17.000000Z","user_id":"6"}]}}'
+        content: '{"data":{"id":6,"name":"Maximillia Stracke","email":"schaefer.marielle@example.net","side_projects":[{"id":10,"name":"et eaque in","description":"Error et mollitia pariatur enim.","url":null,"due_at":"20281002","created_at":"2021-05-30T01:04:25.000000Z","updated_at":"2021-05-30T01:04:25.000000Z","user_id":"6"}]}}'
         headers: []
         description: null
       -
@@ -137,7 +137,7 @@ endpoints:
         name: id
         description: 'The ID of the user.'
         required: true
-        example: 11
+        example: 14
         type: integer
     queryParameters: []
     bodyParameters: []

.scribe/endpoints/1.yaml

@@ -60,19 +60,19 @@ endpoints:
         name: description
         description: 'A longer description of your side project. The value must not be greater than 255 characters.'
         required: false
-        example: szzvblztjfkdcmbnyysgwaagmzzqsujuvpbfznqhdmixenuexclndzcqzufmzfuqiwccyiaskjwvgupofzwbgfpegblnuzsqqpbqgsgfgujnefakxbecccbmogvbydjszntyazlkgsgsuhzyqiedsqyvwgepiotomphpxrfgxkhgeqpwtjtnkguxdbmuwsscywbgmerhulfvznigtfezrgmmngkmltynhsenqenrgwhpklflyedqiwuhkcyy
+        example: fgjbfzbzhamascqffkukusyxpfhhnexibriqgoylogtkynblcsjszzfmuiyixsoborxcppjuwtwugoxonwehwavbbmbycmufnnqlatfoqoxlylkouuojexovacalpbjnuwnmbcbgnwqidmlgcgplkzzbf
         type: string
       url:
         name: url
         description: 'A url to your side project. The value must be a valid URL.'
         required: false
-        example: 'http://www.lemke.info/id-nihil-earum-minima-ea-quis-tempora.html'
+        example: 'http://www.bayer.org/architecto-laudantium-perferendis-doloribus-sint'
         type: string
       due_at:
         name: due_at
         description: 'Due date for the side project. The value must be a valid date. The value must be a valid date in the format Ymd. The value must be a date after <code>today</code>.'
         required: false
-        example: '2062-01-04'
+        example: '2112-08-03'
         type: string
     responses: []
     responseFields: []
@@ -103,7 +103,7 @@ endpoints:
     responses:
       -
         status: 200
-        content: '{"data":{"name":"voluptatem mollitia odit","description":"Atque molestiae soluta libero vitae pariatur at.","due_date":"20240222","owner":{"id":1,"name":"Pete","email":"[email protected]","email_verified_at":null,"created_at":"2021-05-29T22:53:05.000000Z","updated_at":"2021-05-29T22:53:05.000000Z"}}}'
+        content: '{"data":{"name":"omnis facere quia","description":"Porro atque exercitationem aspernatur doloribus reiciendis quo repellendus.","due_date":"20280807","owner":{"id":1,"name":"Pete","email":"[email protected]","email_verified_at":null,"created_at":"2021-05-29T22:53:05.000000Z","updated_at":"2021-05-29T22:53:05.000000Z"}}}'
         headers: []
         description: null
     responseFields: []
@@ -124,7 +124,7 @@ endpoints:
         name: id
         description: 'The ID of the side project.'
         required: true
-        example: 3
+        example: 4
         type: integer
     queryParameters: []
     bodyParameters: []
@@ -146,7 +146,7 @@ endpoints:
         name: id
         description: 'The ID of the side project.'
         required: true
-        example: 16
+        example: 6
         type: integer
     queryParameters: []
     bodyParameters: []

.scribe/endpoints/2.yaml

@@ -19,19 +19,19 @@ endpoints:
         name: name
         description: 'The value must be at least 1 characters. The value must not be greater than 255 characters.'
         required: true
-        example: smwrfzagusffdunbvldexcnxwwlekvhhzuadousqjqlzhfjyrjieurdsegqxaadncagszmgajcaoasevirpdknbggkemhnvgupmxxqfwbfkkpitdcjcowrrajpflaltrcdwfnicxxibboaqtkqr
+        example: meinzggvhunivpobtwkftopruribdemrysmmuudebsbyazghwgwjlslewevcvocfftaryqiuqxlfbbyguukraxzd
         type: string
       email:
         name: email
         description: 'The value must be a valid email address.'
         required: true
-        example: lemke.jillian@example.com
+        example: shanahan.bridie@example.net
         type: string
       password:
         name: password
         description: ''
         required: true
-        example: nemo
+        example: magni
         type: string
     responses: []
     responseFields: []
@@ -53,14 +53,14 @@ endpoints:
         name: id
         description: 'The ID of the user.'
         required: true
-        example: 8
+        example: 4
         type: integer
     queryParameters: []
     bodyParameters: []
     responses:
       -
         status: 200
-        content: '{"data":{"id":6,"name":"Alvina Krajcik","email":"rhoda22@example.net","side_projects":[{"id":10,"name":"labore neque necessitatibus","description":"Et omnis occaecati aut ab porro est qui harum.","url":null,"due_at":"20250126","created_at":"2021-05-30T00:34:17.000000Z","updated_at":"2021-05-30T00:34:17.000000Z","user_id":"6"}]}}'
+        content: '{"data":{"id":6,"name":"Maximillia Stracke","email":"schaefer.marielle@example.net","side_projects":[{"id":10,"name":"et eaque in","description":"Error et mollitia pariatur enim.","url":null,"due_at":"20281002","created_at":"2021-05-30T01:04:25.000000Z","updated_at":"2021-05-30T01:04:25.000000Z","user_id":"6"}]}}'
         headers: []
         description: null
       -
@@ -135,7 +135,7 @@ endpoints:
         name: id
         description: 'The ID of the user.'
         required: true
-        example: 11
+        example: 14
         type: integer
     queryParameters: []
     bodyParameters: []

.scribe/index.md

@@ -2,13 +2,13 @@
 
 Start (and never finish) side projects with this API.
 
-This documentation aims to provide all the information you need to work with our API.
+The SideProject API is a sample API, built to demonstrate Scribe's capabilities.
+
+Lke many side projects, it is itself an unfinished API, but hopefully it should be enough to convince you to try Scribe out.😉 You can check out the source code [on GitHub](https://github.com/knuckleswtf/TheSideProjectAPI/).
 
 <aside class="success">Example of aside with class=success.</aside>
 <aside class="warning">Example of aside with class=warning.</aside>
 
-This is an unfinished API (get it?), but hopefully it should be enough to convince you to try Scribe out.😉
-
 <aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
 You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>
 

README.md

@@ -1,3 +1,6 @@
 # The SideProject API
 
-Sample API to demonstrate Scribe's API documentation capabilities. See the docs at [sample.scribe.knuckles.wtf](http://sample.scribe.knuckles.wtf).
+Sample (Laravel) API to demonstrate [Scribe's](http://scribe.knuckles.wtf) API documentation capabilities. See the docs at [sample.scribe.knuckles.wtf](http://sample.scribe.knuckles.wtf).
+
+
+The docs are built with `php artisan scribe:generate`, and then moved into the docs/ folder, so that GitHub Pages can work with them. This two-step process is handled with the `composer docs` command.

app/Http/Controllers/SideProjectController.php

@@ -2,7 +2,6 @@
 
 namespace App\Http\Controllers;
 
-use App\Http\Transformers\BadWordTransformer;
 use App\Http\Transformers\SideProjectTransformer;
 use App\Models\SideProject;
 use Illuminate\Http\Request;

composer.json

@@ -52,6 +52,10 @@
         ],
         "post-create-project-cmd": [
             "@php artisan key:generate --ansi"
+        ],
+        "docs": [
+            "@php artisan scribe:generate",
+            "@php copy-docs-for-gh-pages.php"
         ]
     },
     "extra": {

copy-docs-for-gh-pages.php

@@ -0,0 +1,17 @@
+<?php
+
+@mkdir('docs/css', 0777, true);
+@mkdir('docs/js', 0777, true);
+@mkdir('docs/images', 0777, true);
+
+foreach(glob("public/docs/*.*") as $file) {
+    print_r($file, str_replace("public/", "", $file)."\n");
+    copy($file, str_replace("public/", "", $file));
+}
+foreach(glob("public/docs/*/*.*") as $file) {
+    print_r($file, str_replace("public/", "", $file)."\n");
+    copy($file, str_replace("public/", "", $file));
+}
+
+file_put_contents("docs/CNAME", "sample.scribe.knuckles.wtf");
+echo "Copied docs for GH pages";