Skip to content

Commit 8fa8867

Browse files
pavanpodilapavanpodila
committedJan 22, 2025·
package updates
1 parent fbb60e0 commit 8fa8867

File tree

5 files changed

+422
-395
lines changed

5 files changed

+422
-395
lines changed
 

‎astro.config.ts

+12-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import sidebar from './sidebar.ts'
1111
import rehypeExternalLinks from 'rehype-external-links'
1212

1313
import icon from 'astro-icon'
14+
import starlightCoolerCredit from 'starlight-cooler-credit'
1415

1516
// https://astro.build/config
1617
export default defineConfig({
@@ -85,7 +86,17 @@ export default defineConfig({
8586
showLineNumbers: false,
8687
},
8788
},
88-
plugins: [starlightLinksValidator()],
89+
plugins: [
90+
starlightLinksValidator(),
91+
starlightCoolerCredit({
92+
customImage: './src/assets/logo.svg',
93+
credit: {
94+
title: 'Vyuh',
95+
href: 'https://vyuh.tech',
96+
description: 'Build Modular, Scalable Flutter Apps.',
97+
},
98+
}),
99+
],
89100
editLink: {
90101
baseUrl: 'https://github.com/vyuh-tech/docs/edit/main/',
91102
},

‎package.json

+5-4
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313
},
1414
"dependencies": {
1515
"@astrojs/check": "^0.9.4",
16-
"@astrojs/react": "^4.1.5",
16+
"@astrojs/react": "^4.1.6",
1717
"@astrojs/starlight": "^0.30.6",
1818
"@astrojs/starlight-tailwind": "^3.0.0",
19-
"@astrojs/tailwind": "^5.1.4",
19+
"@astrojs/tailwind": "^5.1.5",
2020
"@expressive-code/plugin-line-numbers": "^0.38.3",
21-
"@iconify-json/mdi": "^1.2.2",
21+
"@iconify-json/mdi": "^1.2.3",
2222
"@types/react": "^19.0.7",
2323
"@types/react-dom": "^19.0.3",
24-
"astro": "^5.1.7",
24+
"astro": "^5.1.8",
2525
"astro-embed": "^0.9.0",
2626
"astro-icon": "^1.1.5",
2727
"firebase-tools": "^13.29.1",
@@ -30,6 +30,7 @@
3030
"react-dom": "^19.0.0",
3131
"rehype-external-links": "^3.0.0",
3232
"sharp": "^0.33.5",
33+
"starlight-cooler-credit": "^0.2.3",
3334
"starlight-links-validator": "^0.13.4",
3435
"starlight-showcases": "^0.3.0",
3536
"tailwindcss": "^3.4.17",

‎pnpm-lock.yaml

+270-251
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/assets/logo.svg

+7-21
Loading

‎src/content/docs/intro/index.mdx

+128-118
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ description: Introduction to the Vyuh Framework
44
---
55

66
import { Aside } from '@astrojs/starlight/components'
7+
import { Image } from 'astro:assets'
8+
9+
import vyuhLogo from '@/assets/logo.svg'
710

811
Vyuh is a framework for building _modular, large scale_ **Mobile** and **Web**
912
apps (aka _Super Apps_). It uses **Flutter** to drive the App Experience and an
@@ -13,7 +16,9 @@ _optional_ **Server-Driven UI** using a headless **CMS**.
1316
> of **modular Mini-Apps**. Vyuh allows you to create a _single unified App
1417
> Experience_ that can connect multiple mini-apps.
1518
16-
![](../../../assets/logo.png)
19+
<div className={'flex flex-row items-center justify-center'}>
20+
<Image src={vyuhLogo} alt={'Vyuh Logo'} width={128} height={128} />
21+
</div>
1722

1823
This CMS-driven approach helps in **dramatically reducing your time** 🕛 to ship
1924
new features with a **much smaller team** 😇.
@@ -35,9 +40,23 @@ This is possible because the framework takes care of all the fundamentals of
3540
building large scale apps. This includes things like:
3641

3742
- **CMS**-driven (aka _Server-driven_) UI
38-
- Custom Content types
43+
44+
<Aside title={'CMS is Optional'}>
45+
46+
Vyuh works with a headless CMS like **Sanity.io** out-of-the-box. However, the
47+
CMS piece is **completely optional** and you can include it as and when you need
48+
it. In fact, it supports different levels of granularity where you can have the
49+
entire app driven through a CMS, a single page rendered from a CMS, or even a
50+
component coming from a CMS.
51+
52+
The extent of usage is up to you, and you can start by not having it at all
53+
inside your application
54+
55+
</Aside>
56+
57+
- Custom **Content types**
3958
- Actions, Layouts, Conditions, Routes
40-
- Custom API Content
59+
- Custom **API Content**
4160
- Custom journeys & Conditional flows
4261
- **Modular** development of **Features** with independent teams
4362
- Third party integrations via **Plugins**
@@ -61,121 +80,112 @@ of applications** or a **platform for white-labeled applications**, Vyuh is
6180
_ready for your journey_. The benefits below will be a _catalyst_ for _**faster
6281
time to market**_.
6382

64-
<table data-view="cards">
65-
<thead>
66-
<tr>
67-
<th></th>
68-
<th></th>
69-
<th></th>
70-
</tr>
71-
</thead>
72-
<tbody>
73-
<tr>
74-
<td>
75-
<strong>Faster App Deployments</strong>
76-
</td>
77-
<td>
78-
Change the App Experience without any App Store release or deployment
79-
</td>
80-
<td></td>
81-
</tr>
82-
<tr>
83-
<td>
84-
<strong>Explorative Power</strong>
85-
</td>
86-
<td>Explore different variations of your UX without changing any code</td>
87-
<td></td>
88-
</tr>
89-
<tr>
90-
<td>
91-
<strong>Small teams, Big outcomes</strong>
92-
</td>
93-
<td>Build sophisticated Apps with smaller teams and faster outcomes.</td>
94-
<td></td>
95-
</tr>
96-
<tr>
97-
<td>
98-
<strong>Extensibility built-in</strong>
99-
</td>
100-
<td>
101-
Tackle a variety of scenarios in your App Experience with customizations
102-
to the hilt, be it custom content-blocks, layouts, actions, routes or
103-
conditions.
104-
</td>
105-
<td></td>
106-
</tr>
107-
<tr>
108-
<td>
109-
<strong>Server Driven (CMS-driven) UI</strong>
110-
</td>
111-
<td>
112-
Build complete customer journeys using a CMS-driven approach. This
113-
unlocks a new way to deliver experiences without an App Store release.
114-
</td>
115-
<td></td>
116-
</tr>
117-
<tr>
118-
<td>
119-
<strong>Design System First</strong>
120-
</td>
121-
<td>
122-
Use a Design System from the start to avoid visual consistency issues.
123-
</td>
124-
<td></td>
125-
</tr>
126-
<tr>
127-
<td>
128-
<strong>Easy Third-Party integrations</strong>
129-
</td>
130-
<td>
131-
Using API-driven content you can integrate any API, be it ReST, GraphQL
132-
or WebSockets
133-
</td>
134-
<td></td>
135-
</tr>
136-
<tr>
137-
<td>
138-
<strong>Powerful State Management</strong>
139-
</td>
140-
<td>
141-
Use the power of Reactive State with{' '}
142-
<a href="https://pub.dev/packages/mobx">MobX</a> to build simple to
143-
highly sophisticated experiences
144-
</td>
145-
<td></td>
146-
</tr>
147-
<tr>
148-
<td>
149-
<strong>Developer Productivity</strong>
150-
</td>
151-
<td>
152-
Use the two super-powers of Dynamic updates via CMS and Flutter's Hot
153-
Reload to supercharge your Developer Experience.
154-
</td>
155-
<td></td>
156-
</tr>
157-
<tr>
158-
<td>
159-
<strong>Growing Integrations</strong>
160-
</td>
161-
<td>
162-
Make use of the growing set of Plugins to cater to any aspect of your
163-
App Development process from Networking to Analytics to Payments and
164-
much more.
165-
</td>
166-
<td></td>
167-
</tr>
168-
<tr>
169-
<td>
170-
<strong>Fundamentals Ready</strong>
171-
</td>
172-
<td>
173-
Start with the built-in, fundamental building blocks to kickstart your
174-
Application. Use the scaffolding tool to create your initial project.
175-
</td>
176-
<td></td>
177-
</tr>
178-
</tbody>
83+
<table>
84+
<tr>
85+
<td>
86+
<strong>Faster App Deployments</strong>
87+
</td>
88+
<td>
89+
Change the App Experience without any App Store release or deployment
90+
</td>
91+
<td></td>
92+
</tr>
93+
<tr>
94+
<td>
95+
<strong>Explorative Power</strong>
96+
</td>
97+
<td>Explore different variations of your UX without changing any code</td>
98+
<td></td>
99+
</tr>
100+
<tr>
101+
<td>
102+
<strong>Small teams, Big outcomes</strong>
103+
</td>
104+
<td>Build sophisticated Apps with smaller teams and faster outcomes.</td>
105+
<td></td>
106+
</tr>
107+
<tr>
108+
<td>
109+
<strong>Extensibility built-in</strong>
110+
</td>
111+
<td>
112+
Tackle a variety of scenarios in your App Experience with customizations
113+
to the hilt, be it custom content-blocks, layouts, actions, routes or
114+
conditions.
115+
</td>
116+
<td></td>
117+
</tr>
118+
<tr>
119+
<td>
120+
<strong>Server Driven (CMS-driven) UI</strong>
121+
</td>
122+
<td>
123+
Build complete customer journeys using a CMS-driven approach. This unlocks
124+
a new way to deliver experiences without an App Store release.
125+
</td>
126+
<td></td>
127+
</tr>
128+
<tr>
129+
<td>
130+
<strong>Design System First</strong>
131+
</td>
132+
<td>
133+
Use a Design System from the start to avoid visual consistency issues.
134+
</td>
135+
<td></td>
136+
</tr>
137+
<tr>
138+
<td>
139+
<strong>Easy Third-Party integrations</strong>
140+
</td>
141+
<td>
142+
Using API-driven content you can integrate any API, be it ReST, GraphQL or
143+
WebSockets
144+
</td>
145+
<td></td>
146+
</tr>
147+
<tr>
148+
<td>
149+
<strong>Powerful State Management</strong>
150+
</td>
151+
<td>
152+
Use the power of Reactive State with{' '}
153+
<a href="https://pub.dev/packages/mobx">MobX</a> to build simple to highly
154+
sophisticated experiences
155+
</td>
156+
<td></td>
157+
</tr>
158+
<tr>
159+
<td>
160+
<strong>Developer Productivity</strong>
161+
</td>
162+
<td>
163+
Use the two super-powers of Dynamic updates via CMS and Flutter's Hot
164+
Reload to supercharge your Developer Experience.
165+
</td>
166+
<td></td>
167+
</tr>
168+
<tr>
169+
<td>
170+
<strong>Growing Integrations</strong>
171+
</td>
172+
<td>
173+
Make use of the growing set of Plugins to cater to any aspect of your App
174+
Development process from Networking to Analytics to Payments and much
175+
more.
176+
</td>
177+
<td></td>
178+
</tr>
179+
<tr>
180+
<td>
181+
<strong>Fundamentals Ready</strong>
182+
</td>
183+
<td>
184+
Start with the built-in, fundamental building blocks to kickstart your
185+
Application. Use the scaffolding tool to create your initial project.
186+
</td>
187+
<td></td>
188+
</tr>
179189
</table>
180190

181191
## Let's get started

0 commit comments

Comments
 (0)
Please sign in to comment.