Skip to content

Commit 4934d7e

Browse files
tymondesignstymondesigns
committed
docs: Small updates
1 parent ba4d621 commit 4934d7e

22 files changed

Lines changed: 71 additions & 102 deletions

‎docs/assets/favicon.svg‎

Lines changed: 13 additions & 0 deletions
Loading

‎docs/docs.json‎

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
{
22
"$schema": "https://mintlify.com/docs.json",
3-
"theme": "aspen",
3+
"theme": "palm",
44
"name": "CortexPHP",
55
"colors": {
66
"primary": "#1C85FE",
77
"light": "#1C85FE",
88
"dark": "#1C85FE"
99
},
10-
"favicon": "/favicon.svg",
10+
"favicon": "/assets/favicon.svg",
1111
"icons": {
1212
"library": "lucide"
1313
},
1414
"navigation": {
15-
"dropdowns": [
15+
"products": [
1616
{
17-
"dropdown": "JSON Schema",
17+
"product": "JSON Schema",
1818
"icon": "braces",
1919
"groups": [
2020
{
@@ -76,18 +76,13 @@
7676
"light": "/assets/logo-light.svg",
7777
"dark": "/assets/logo-dark.svg"
7878
},
79-
"navbar": {
80-
"primary": {
81-
"type": "github",
82-
"href": "https://github.com/cortexphp/json-schema"
83-
}
84-
},
8579
"contextual": {
8680
"options": ["copy", "view", "chatgpt", "claude"]
8781
},
8882
"footer": {
8983
"socials": {
90-
"github": "https://github.com/cortexphp"
84+
"github": "https://github.com/cortexphp",
85+
"x": "https://twitter.com/cortexphp"
9186
}
9287
}
9388
}

‎docs/json-schema/advanced/conditional-validation.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -618,13 +618,13 @@ $complexSchema = Schema::object('complex_validation')
618618
<Card title="User Account Types" icon="users">
619619
Different validation rules for personal vs business accounts, or basic vs premium users.
620620
</Card>
621-
<Card title="Payment Methods" icon="credit-card">
621+
<Card title="Payment Methods" icon="wallet">
622622
Validate different payment types with their specific required fields and formats.
623623
</Card>
624-
<Card title="Dynamic Forms" icon="form">
624+
<Card title="Dynamic Forms" icon="file-text">
625625
Forms where required fields change based on user selections or enabled features.
626626
</Card>
627-
<Card title="API Versioning" icon="code-branch">
627+
<Card title="API Versioning" icon="git-branch">
628628
Different validation rules for different API versions or client types.
629629
</Card>
630630
</CardGroup>

‎docs/json-schema/advanced/definitions-refs.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -443,10 +443,10 @@ $ecommerceApiSchema = Schema::object('ecommerce_api')
443443
<Card title="Maintainability" icon="wrench">
444444
Update shared schemas in one place and have changes propagate throughout your API.
445445
</Card>
446-
<Card title="Consistency" icon="check-double">
446+
<Card title="Consistency" icon="circle-check">
447447
Ensure consistent validation rules across different parts of your application.
448448
</Card>
449-
<Card title="Modularity" icon="cubes">
449+
<Card title="Modularity" icon="boxes">
450450
Break complex schemas into manageable, reusable components.
451451
</Card>
452452
</CardGroup>
@@ -526,13 +526,13 @@ $schema->addDefinition(
526526
## Common Use Cases
527527

528528
<CardGroup cols={2}>
529-
<Card title="API Schema Design" icon="api">
529+
<Card title="API Schema Design" icon="server">
530530
Create reusable components for API request/response schemas across multiple endpoints.
531531
</Card>
532-
<Card title="Domain Models" icon="cube">
532+
<Card title="Domain Models" icon="box">
533533
Define common business objects like User, Product, Order that are used throughout your application.
534534
</Card>
535-
<Card title="Configuration Schemas" icon="gear">
535+
<Card title="Configuration Schemas" icon="cog">
536536
Share configuration patterns across different parts of your application configuration.
537537
</Card>
538538
<Card title="Form Validation" icon="file-text">

‎docs/json-schema/advanced/dependent-schemas.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -553,10 +553,10 @@ $schema->dependentSchemas([
553553
<Card title="Dynamic Forms" icon="file-text">
554554
Forms where available fields and validation rules change based on user selections.
555555
</Card>
556-
<Card title="API Configuration" icon="gear">
556+
<Card title="API Configuration" icon="cog">
557557
Configuration objects where certain settings require additional parameters.
558558
</Card>
559-
<Card title="Payment Processing" icon="credit-card">
559+
<Card title="Payment Processing" icon="wallet">
560560
Different validation rules for different payment methods and options.
561561
</Card>
562562
<Card title="User Profiles" icon="user">

‎docs/json-schema/advanced/pattern-properties.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -476,13 +476,13 @@ $schema->patternProperties([
476476
## Common Use Cases
477477

478478
<CardGroup cols={2}>
479-
<Card title="Dynamic Configuration" icon="gear">
479+
<Card title="Dynamic Configuration" icon="cog">
480480
Configure applications with dynamic settings that follow naming conventions.
481481
</Card>
482482
<Card title="Multi-language Content" icon="globe">
483483
Validate internationalization data with language-specific property patterns.
484484
</Card>
485-
<Card title="API Versioning" icon="code-branch">
485+
<Card title="API Versioning" icon="git-branch">
486486
Handle different API versions with version-specific property validation.
487487
</Card>
488488
<Card title="Custom Fields" icon="puzzle-piece">

‎docs/json-schema/advanced/string-formats.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,10 +204,10 @@ $userProfileSchema->isValid($validProfile); // true
204204
<Card title="API Parameters" icon="code">
205205
Validate API endpoints, UUIDs, timestamps, and other structured data in API requests.
206206
</Card>
207-
<Card title="Configuration Files" icon="gear">
207+
<Card title="Configuration Files" icon="cog">
208208
Validate URLs, hostnames, IP addresses, and other configuration values.
209209
</Card>
210-
<Card title="Data Import" icon="file-import">
210+
<Card title="Data Import" icon="file-input">
211211
Validate formatted data during import processes with appropriate type checking.
212212
</Card>
213213
</CardGroup>

‎docs/json-schema/advanced/unevaluated-properties.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -413,13 +413,13 @@ $schema = Schema::object('strict_user', SchemaVersion::Draft_2019_09)
413413
<Card title="Strict API Contracts" icon="shield-check">
414414
Ensure API requests/responses contain only expected properties, even with conditional fields.
415415
</Card>
416-
<Card title="Configuration Validation" icon="gear">
416+
<Card title="Configuration Validation" icon="cog">
417417
Validate configuration files with complex conditional requirements and strict property control.
418418
</Card>
419419
<Card title="Form Validation" icon="file-text">
420420
Handle dynamic forms where available fields depend on user selections or conditions.
421421
</Card>
422-
<Card title="Data Migration" icon="exchange-alt">
422+
<Card title="Data Migration" icon="move">
423423
Validate data during migration with strict control over allowed properties and transformations.
424424
</Card>
425425
</CardGroup>

‎docs/json-schema/code-generation/from-classes.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -499,16 +499,16 @@ Validation rules like minLength, pattern, format are not extracted from docblock
499499
## Common Use Cases
500500

501501
<CardGroup cols={2}>
502-
<Card title="API Documentation" icon="api">
502+
<Card title="API Documentation" icon="server">
503503
Generate OpenAPI schemas from your data transfer objects and API models.
504504
</Card>
505505
<Card title="Form Validation" icon="file-text">
506506
Create client-side validation schemas from your backend models.
507507
</Card>
508-
<Card title="Data Migration" icon="exchange-alt">
508+
<Card title="Data Migration" icon="move">
509509
Validate data integrity during migrations using existing model definitions.
510510
</Card>
511-
<Card title="Configuration Validation" icon="gear">
511+
<Card title="Configuration Validation" icon="cog">
512512
Generate schemas for application configuration classes.
513513
</Card>
514514
</CardGroup>

‎docs/json-schema/code-generation/from-closures.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ function handleUserStuff($data, $action, $options = []) {}
469469
<Card title="Data Pipeline" icon="stream">
470470
Validate data transformations and processing steps in data pipelines.
471471
</Card>
472-
<Card title="Configuration" icon="gear">
472+
<Card title="Configuration" icon="cog">
473473
Generate validation for configuration and setup functions.
474474
</Card>
475475
</CardGroup>

0 commit comments

Comments
 (0)