Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix Stoplight typo #20

Merged
merged 1 commit into from
Sep 21, 2022
Merged

Fix Stoplight typo #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ weight: 0

Scramble generates API documentation for Laravel project. Without requiring you to manually write PHPDoc annotations.

Docs are generated in OpenAPI 3.1.0 format. To show the documentation in UI, [Spotlight Elements](https://github.com/stoplightio/elements) is used.
Docs are generated in OpenAPI 3.1.0 format. To show the documentation in UI, [Stoplight Elements](https://github.com/stoplightio/elements) is used.

The main motto of the project is to generate as much API documentation automatically as possible. This allows you to focus on code and avoid annotating every possible param/field as it may result in outdated documentation. By generating docs automatically from the code your API will always have up-to-date documentation you can trust.