API Guide

[wcostaprijo]

Scribe version

4.35

Your question

Is it possible to create an API Guide using this library with Laravel?

[ x ] Laravel 11.x [ x ] Scribe 4.35

Docs

• [X] I've checked the docs, the troubleshooting guide, and existing issues, but I didn't find a solution

[shalvah]

What do you mean by an API guide?

[wcostaprijo]

An API Guide provides a comprehensive and contextual overview of the API, including detailed descriptions of concepts, step-by-step guides, usage examples, best practices, and perhaps even tutorials. This documentation is typically more focused on helping developers understand how to use the API in their own projects, providing guidance and insights on how to make the most of the API's features.

[AryaSvitkona]

@wcostaprijo You mean something like that? https://adidas.gitbook.io/api-guidelines (see for others: https://apistylebook.com/design/guidelines/)

Well I would rather use Gitbook for that and use Scribe to generate the technical documentation :)