瀏覽代碼

Add notice to all doc pages

shalvah 3 年之前
父節點
當前提交
090dfcdd24

+ 5 - 0
docs/architecture.md

@@ -1,4 +1,9 @@
 # How Scribe works
+
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 Read this page if you want a deeper understanding of how Scribe works (for instance, for the purpose of contributing).
 
 - When the `generate` command is run, the Generator fetches all your application's routes from Laravel's (or DIngo's) Route facade.

+ 5 - 0
docs/config.md

@@ -1,4 +1,9 @@
 # Configuration
+
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 Here's a rundown of what's available in the `config/scribe.php` file. 
 
 ```eval_rst

+ 5 - 0
docs/contributing.md

@@ -1,4 +1,9 @@
 # Contributing to Scribe
+
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 ```eval_rst
 .. Important:: Please read this guide before sending in your contribution! There aren't many rules, just a few guidelines to help everyone.😄
 ```

+ 5 - 0
docs/customization.md

@@ -1,4 +1,9 @@
 # Customizing the generated documentation
+
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 Scribe offers you multiple options to customize how your documentation is rendered.
 
 ## Manually modifying the documentation after generating

+ 5 - 0
docs/documenting/documenting-api-information.md

@@ -1,5 +1,10 @@
 # Adding general information about your API
 
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
+
 ## Authentication information
 You can add authentication information for your API using the `auth` section in `scribe.php`. 
 

+ 5 - 0
docs/documenting/documenting-endpoint-body-parameters.md

@@ -1,4 +1,9 @@
 # Documenting body and file parameters for an endpoint
+
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 Scribe can get information about your endpoint's body parameters in two ways:
 - the fully-manual way (using the `@bodyParam` annotation)
 - the mostly-automatic way (using FormRequests)

+ 5 - 0
docs/documenting/documenting-endpoint-headers.md

@@ -1,5 +1,10 @@
 # Documenting headers for endpoints
 
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
+
 To specify headers to be added to your endpoints, use the `apply.headers` section of the route group in `scribe.php`. For instance, if you have this config:
 
 ```php

+ 5 - 0
docs/documenting/documenting-endpoint-metadata.md

@@ -1,5 +1,10 @@
 # Specifying metadata about an endpoint
 
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
+
 ## Endpoint title and description
 To set an endpoint's title and description, just write in the method's docblock. The first paragraph will be used as the title, the rest as the description. Custom formatting (such as `<aside>` tags) is also supported (see the [Pastel docs](http://github.com/knuckleswtf/pastel)).
 

+ 5 - 0
docs/documenting/documenting-endpoint-query-parameters.md

@@ -1,5 +1,10 @@
 # Documenting query and URL parameters for an endpoint
 
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
+
 ## Specifying query parameters
 To describe query parameters for your endpoint, use the `@queryParam` annotation on the method handling it.
 

+ 5 - 0
docs/documenting/documenting-endpoint-responses.md

@@ -1,4 +1,9 @@
 # Documenting responses from an endpoint
+
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 It's helpful if your API's consumers can see what a response should be like before writing any code. There are multiple strategies to provide example responses for your endpoint:
 - describing the response using the `@response` tag
 - specifying a file containing the response using the `@responseFile` tag

+ 5 - 0
docs/documenting/index.md

@@ -1,4 +1,9 @@
 # Documenting your API
+
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 Scribe tries to infer information about your API from your code, but you can enrich this information in the config and by using annotations (tags in doc block comments).
 
 ```eval_rst

+ 5 - 0
docs/generating-documentation.md

@@ -1,5 +1,10 @@
 # Generating Documentation
 
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
+
 To generate your API documentation, use the `scribe:generate` artisan command.
 
 ```sh

+ 5 - 0
docs/guide-getting-started.md

@@ -1,5 +1,10 @@
 # Getting Started
 
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
+
 ## Set up the package
 First, install the package:
 

+ 4 - 0
docs/migrating-v2.md

@@ -1,4 +1,8 @@
 # Scribe 2: What's new, and how to migrate
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 
 Scribe 2 comes with a bunch of changes focused on making the documentation process easier and the output nicer. There aren't many "shiny" changes, mostly improvements to what works. We've marked required changes in the list below with a "Migration Required" label.
 

+ 5 - 0
docs/migrating.md

@@ -1,4 +1,9 @@
 # Migrating from mpociot/laravel-apidoc-generator to Scribe v1
+
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 There's quite a few changes in Scribe, and this guide aims to show you the key parts you need to look out for so things don't break. After migrating, you should also check out the [list of new features](./whats-new.html).
 
 ```eval_rst

+ 4 - 0
docs/plugins.md

@@ -1,4 +1,8 @@
 # Extending functionality with plugins
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 You can use plugins to alter Scribe's behaviour when extracting info about your endpoints. For instance, suppose all your listing endpoints support pagination query parameters `pageSize` and `page`, and you don't want to annotate with `@queryParam` on each method. You can create a plugin that adds this to all your query parameters. Let's see how to do this.
 
 ## The stages of route processing

+ 4 - 0
docs/troubleshooting.md

@@ -1,4 +1,8 @@
 # Troubleshooting and Debugging
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 This page contains a few tips to help you figure out what's wrong when Scribe seems to be slow or malfunctioning.
 
 ## Update your installation

+ 4 - 0
docs/whats-new.md

@@ -1,4 +1,8 @@
 # What's new in Scribe
+```eval_rst
+.. attention:: These docs are for Scribe v2, which is no longer maintained. See `scribe.knuckles.wtf/laravel <http://scribe.knuckles.wtf/laravel>`_ for Scribe v3.
+```
+
 ```eval_rst
 .. Note:: This page is aimed at users coming from mpociot/laravel-apidoc-generator. It should give you an overview of what's new in Scribe, and point you to the relevant documentation on each. Once you're ready to migrate, check out `the migration guide <migrating.html>`_.
 ```