Skip to content

Commit 8085086

Browse files
authored
Removing dead links (#795)
* Removing dead links * Remove more dead links
1 parent 7032d70 commit 8085086

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/getting-started/generating-documentation.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The base URL used in the Postman collection will be the value of the `base_url`
2626
## Manually modifying the content of the generated documentation
2727
If you want to modify the content of your generated documentation without changing the routes, go ahead and edit the generated `index.md` file.
2828

29-
This file is located in the `source` folder of your `output` directory (see [configuration](config.html#output)), so by default, this is `public/docs/source/index.md`.
29+
This file is located in the `source` folder of your `output` directory (see configuration), so by default, this is `public/docs/source/index.md`.
3030

3131
After editing the markdown file, you can use the `apidoc:rebuild` command to rebuild your documentation into HTML.
3232

@@ -40,7 +40,7 @@ php artisan apidoc:rebuild
4040
The contents of `prepend.md` will be added after the front matter and info text, while the contents of `append.md` will be added at the end of the document.
4141

4242
## Specifying language for examples
43-
For each endpoint, an example request is shown in [each language configured](config.html#example-languages). To add a language which is not supported by this package, you'll have to create your own view for how an example should render. Here's how:
43+
For each endpoint, an example request is shown in each language configured. To add a language which is not supported by this package, you'll have to create your own view for how an example should render. Here's how:
4444

4545
- Publish the vendor views by running:
4646

@@ -54,8 +54,8 @@ php artisan apidoc:rebuild
5454
- `methods`: an array of the HTTP methods for that route
5555
- `boundUri`: the complete URL for the route, with any url parameters replaced (/users/{id} -> /users/1)
5656
- `headers`: key-value array of headers to be sent with route (according to your configuration)
57-
- `cleanQueryParameters`: key-value array of query parameters with example values to be sent with the request. Parameters which have been excluded from the example requests (see [Example Parameters](documenting.html#example-parameters)) will not be present here.
58-
- `cleanBodyParameters`: key-value array of body parameters with example values to be sent with the request. Parameters which have been excluded from the example requests (see [Example Parameters](documenting.html#example-parameters)) will not be present here.
57+
- `cleanQueryParameters`: key-value array of query parameters with example values to be sent with the request. Parameters which have been excluded from the example requests (see Example Parameters at Documenting your API) will not be present here.
58+
- `cleanBodyParameters`: key-value array of body parameters with example values to be sent with the request. Parameters which have been excluded from the example requests (see Example Parameters at Documenting your API will not be present here.
5959

6060
- Add the language to the `example_languages` array in the package config.
6161

docs/under-the-hood/how-it-works.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ order: 2
88
After installing this package and running the command `php artisan apidoc:generate` in your application, here's what happens:
99

1010
- The package fetches all your application's routes.
11-
- It looks through your [configuration file](config.md) to filter the routes to the ones you actually want to document. For each route, it retrieves the settings you want to apply to it, if any.
11+
- It looks through your configuration file to filter the routes to the ones you actually want to document. For each route, it retrieves the settings you want to apply to it, if any.
1212
- It processes each route. "Process" here involves using a number of strategies to extract the route's information: group, title, description, body parameters, query parameters, and a sample response, if possible.
1313
- After processing the routes, it generates a markdown file describing the routes from the parsed data and passes them to [Documentarian](https://github.com/mpociot/documentarian), which wraps them in a theme and converts them into HTML and CSS.
14-
- It generates a Postman API collection for your routes. ([This can be disabled.](config.html#postman))
14+
- It generates a Postman API collection for your routes. This can be disabled.

0 commit comments

Comments
 (0)