Skip to content

Commit 8118b89

Browse files
mweinschenkmweinschenk
committed
chore: improve docs
1 parent 5139463 commit 8118b89

18 files changed

+622
-941
lines changed

‎docs/.vitepress/config.mts‎

Lines changed: 63 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,75 @@
1-
import { defineConfig } from 'vitepress';
1+
import {defineConfig} from 'vitepress';
22
import pkg from '../package.json'
33

44
export default defineConfig({
5-
title: 'Laravel EVM',
6-
description: 'Reliable EVM interaction for Laravel (contracts, async transactions, fees, nonces, multi-RPC)',
7-
srcDir: './pages',
8-
cleanUrls: true,
9-
lastUpdated: true,
10-
markdown: {
5+
title: 'Laravel EVM',
6+
description: 'Simple, Reliable Ethereum Integration for Laravel',
7+
srcDir: './pages',
8+
cleanUrls: true,
9+
lastUpdated: true,
10+
markdown: {
1111
theme: {
1212
light: 'github-light',
1313
dark: 'github-dark'
1414
}
1515
},
16-
themeConfig: {
17-
nav: [
18-
{ text: 'Guide', link: '/pages/README' },
19-
{ text: 'Architecture', link: '/pages/architecture' },
20-
{ text: 'Configuration', link: '/pages/configuration' },
21-
{ text: 'Transactions', link: '/pages/transactions' },
22-
{ text: 'Events', link: '/pages/events' },
23-
{ text: 'Facades', link: '/pages/facades' },
24-
{ text: 'Examples', link: '/pages/examples' }
25-
],
26-
sidebar: {
27-
'/pages/': [
28-
{
29-
text: 'Overview',
30-
items: [
31-
{ text: 'Introduction', link: '/pages/README#introduction' },
32-
{ text: 'Quick Start', link: '/pages/README#quick-start' },
33-
{ text: 'Core Concepts', link: '/pages/README#core-concepts' }
34-
]
35-
},
36-
{
37-
text: 'Architecture',
38-
items: [
39-
{ text: 'Component Diagram', link: '/pages/architecture#component-diagram' },
40-
{ text: 'Transaction Lifecycle', link: '/pages/architecture#transaction-job-lifecycle' },
41-
{ text: 'Events', link: '/pages/events' }
42-
]
43-
},
44-
{
45-
text: 'Runtime',
46-
items: [
47-
{ text: 'Configuration', link: '/pages/configuration' },
48-
{ text: 'Facades', link: '/pages/facades' },
49-
{ text: 'Transactions', link: '/pages/transactions' },
50-
{ text: 'Events', link: '/pages/events' },
51-
{ text: 'Examples', link: '/pages/examples' }
52-
]
16+
themeConfig: {
17+
// https://vitepress.dev/reference/default-theme-config
18+
nav: [
19+
{ text: 'Home', link: '/' },
20+
{
21+
text: pkg.version,
22+
items: [
23+
{
24+
text: 'Changelog',
25+
link: 'https://github.com/farbcodegmbh/laravel-stateful-resources/blob/main/CHANGELOG.md'
26+
},
27+
{
28+
text: 'Contributing',
29+
link: 'https://github.com/farbcodegmbh/laravel-stateful-resources/blob/main/CONTRIBUTING.md'
30+
}
31+
]
32+
}
33+
],
34+
35+
sidebar: [
36+
{
37+
text: 'Basics',
38+
items: [
39+
{ text: 'Installation', link: '/installation' },
40+
{ text: 'Basic Usage', link: '/basic-usage' },
41+
]
42+
},
43+
{
44+
text: 'Advanced Usage',
45+
items: [
46+
{ text: 'Events', link: '/advanced-events' },
47+
{ text: 'Log Querying', link: '/advanced-logs' },
48+
{ text: 'Other Components', link: '/advanced-other' },
49+
]
50+
},
51+
{
52+
text: 'Reference',
53+
items: [
54+
{ text: 'API Reference', link: '/reference' },
55+
]
56+
}
57+
],
58+
59+
socialLinks: [
60+
{icon: 'github', link: 'https://github.com/farbcodegmbh/laravel-evm'},
61+
{
62+
icon: {svg: '<svg width="100%" height="100%" viewBox="0 0 215 215" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;"><rect id="Artboard1" x="0" y="0" width="215" height="215" style="fill:none;"/><g><g><path d="M164.136,6.857L211.041,6.857L122.651,207.615L75.746,207.615L164.136,6.857Z" style="fill:#003e99;fill-rule:nonzero;"/><path d="M93.089,6.857L140.027,6.857L51.637,207.615L4.732,207.615L93.089,6.857Z" style="fill:#0bbaee;fill-rule:nonzero;"/></g></g></svg>'},
63+
link: 'https://farbcode.net'
64+
},
65+
],
66+
footer: {
67+
message: 'Released under the MIT License.',
68+
copyright: 'Copyright © 2025-present //farbcode GmbH'
5369
},
54-
{
55-
text: 'Advanced',
56-
items: [
57-
{ text: 'Extensibility Points', link: '/pages/architecture#extensibility-points' },
58-
{ text: 'Concurrency Model', link: '/pages/architecture#concurrency-model' },
59-
{ text: 'Security Considerations', link: '/pages/architecture#security-considerations' }
60-
]
70+
71+
search: {
72+
provider: 'local',
6173
}
62-
]
63-
},
64-
socialLinks: [
65-
{ icon: 'github', link: 'https://github.com/farbcodegmbh/laravel-evm' }
66-
],
67-
footer: {
68-
message: 'MIT Licensed',
69-
copyright: 'Copyright © 2025 //farbcode GmbH'
7074
}
71-
}
7275
});

‎docs/.vitepress/theme/custom.css‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:root {
2+
--vp-c-brand-1: #003e99;
3+
--vp-c-brand-2: #0da4d2;
4+
--vp-c-brand-3: #0BBAEE;
5+
--vp-c-brand-soft: rgba(11, 185, 238, 0.765);
6+
}
7+
8+
.dark {
9+
--vp-c-brand-1: #0BBAEE;
10+
--vp-c-brand-2: #0046af;
11+
--vp-c-brand-3: #003e99;
12+
--vp-c-brand-soft: rgba(0, 61, 153, 0.765);
13+
}

‎docs/.vitepress/theme/index.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import DefaultTheme from 'vitepress/theme'
2+
import './custom.css'
3+
4+
export default DefaultTheme

‎docs/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "0.3.0",
2+
"version": "0.1.0",
33
"devDependencies": {
44
"vitepress": "^1.6.3"
55
},
@@ -8,4 +8,4 @@
88
"docs:build": "vitepress build",
99
"docs:preview": "vitepress preview"
1010
}
11-
}
11+
}

0 commit comments

Comments
 (0)