Update Scribe configuration for Truncgil Finance: Set title and description, change documentation type to external_laravel, and update theme to scalar. Enhance user experience with additional features and a clear interface for accessing financial data.
This commit is contained in:
+10
-4
@@ -4,10 +4,10 @@ use Knuckles\Scribe\Extracting\Strategies;
|
||||
|
||||
return [
|
||||
// The HTML <title> for the generated documentation. If this is empty, Scribe will infer it from config('app.name').
|
||||
'title' => null,
|
||||
'title' => "Truncgil Finance",
|
||||
|
||||
// A short description of your API. Will be included in the docs webpage, Postman collection and OpenAPI spec.
|
||||
'description' => '',
|
||||
'description' => 'Daily Financial Data: Provides access to real-time financial data updated through the Truncgil API, allowing users to track the daily performance of currency exchange rates and cryptocurrencies.',
|
||||
|
||||
// The base URL displayed in the docs. If this is empty, Scribe will use the value of config('app.url') at generation time.
|
||||
// If you're using `laravel` type, you can set this to a dynamic string, like '{{ config("app.tenant_url") }}' to get a dynamic base URL.
|
||||
@@ -44,10 +44,10 @@ return [
|
||||
// - "laravel" will generate the documentation as a Blade view, so you can add routing and authentication.
|
||||
// - "external_static" and "external_laravel" do the same as above, but generate a basic template,
|
||||
// passing the OpenAPI spec as a URL, allowing you to easily use the docs with an external generator
|
||||
'type' => 'static',
|
||||
'type' => 'external_laravel',
|
||||
|
||||
// See https://scribe.knuckles.wtf/laravel/reference/config#theme for supported options
|
||||
'theme' => 'default',
|
||||
'theme' => 'scalar',
|
||||
|
||||
'static' => [
|
||||
// HTML documentation, assets and Postman collection will be generated to this folder.
|
||||
@@ -127,6 +127,12 @@ This documentation aims to provide all the information you need to work with our
|
||||
|
||||
<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>
|
||||
|
||||
Easy to Use: With a clean and organized user interface, users can quickly access financial data and easily select their desired asset class.
|
||||
|
||||
Developability: The application has a modular and extensible structure, providing developers with a flexible ground to add new features.
|
||||
|
||||
"Truncgil Finance" is an ideal solution for developers and finance professionals who want to quickly adapt to dynamic changes in the financial world.
|
||||
INTRO
|
||||
,
|
||||
|
||||
|
||||
Reference in New Issue
Block a user