Skip to content

Commit 1af234a

Browse files
committed
Optimized the structure.
1 parent 0f1ad00 commit 1af234a

File tree

4 files changed

+51
-29
lines changed

4 files changed

+51
-29
lines changed

.vitepress/config.mts

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,57 +6,48 @@ export default withMermaid({
66
title: "CosmWasm",
77
description: "User guide for CosmWasm smart contract developers",
88
head: [['link', {rel: 'icon', href: '/cosmwasm-small.svg'}]],
9+
lastUpdated: true,
910
themeConfig: {
1011
logo: '/cosmwasm-small.svg',
1112
nav: [
13+
{text: 'Welcome', link: '/guide/welcome'},
1214
{
13-
text: 'Guide',
15+
text: 'CosmWasm Core',
1416
items: [
15-
{text: 'Welcome', link: '/guide/welcome'},
17+
{text: 'Introduction', link: '/guide/cosmwasm-core/introduction'},
18+
{text: 'Installation', link: '/guide/cosmwasm-core/installation'},
1619
{
17-
text: 'CosmWasm Core',
20+
text: 'Architecture',
1821
items: [
19-
{text: 'Introduction', link: '/guide/cosmwasm-core/introduction'},
20-
{text: 'Installation', link: '/guide/cosmwasm-core/installation'},
22+
{text: 'Gas', link: '/guide/cosmwasm-core/architecture/gas'},
2123
]
22-
},
23-
],
24-
24+
}
25+
]
2526
},
2627
],
2728
sidebar: [
29+
{text: 'Welcome', link: '/guide/welcome'},
2830
{
29-
text: 'Guide',
31+
text: 'CosmWasm Core',
32+
collapsed: true,
3033
items: [
34+
{text: 'Introduction', link: '/guide/cosmwasm-core/introduction'},
35+
{text: 'Installation', link: '/guide/cosmwasm-core/installation'},
3136
{
32-
text: 'Welcome', link: '/guide/welcome'
33-
},
34-
{
35-
text: 'CosmWasm Core',
36-
link: '/guide/cosmwasm-core/introduction',
37+
text: 'Architecture',
3738
collapsed: true,
3839
items: [
39-
{text: 'Installation', link: '/guide/cosmwasm-core/installation'},
40-
{
41-
text: 'Architecture',
42-
link: '/guide/cosmwasm-core/architecture/architecture',
43-
collapsed: true,
44-
items: [
45-
{text: 'Gas', link: '/guide/cosmwasm-core/architecture/gas'},
46-
]
47-
},
40+
{text: 'Gas', link: '/guide/cosmwasm-core/architecture/gas'},
4841
]
4942
},
50-
],
43+
]
5144
},
5245
],
5346
search: {
5447
provider: 'local'
5548
}
5649
},
57-
mermaid: {
58-
// Refer https://mermaid.js.org/config/setup/modules/mermaidAPI.html#mermaidapi-configuration-defaults for options.
59-
},
50+
mermaid: {},
6051
markdown: {
6152
math: true
6253
},

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
11
# CosmWasm User Guide
22

3+
**A documentation-focused website for CosmWasm technologies**
4+
5+
## Overview
6+
7+
No matter if you're integrating CosmWasm with a chain, writing smart contracts, or just curious
8+
about what CosmWasm can do, you'll find everything you need here - from the core and wasmd,
9+
to storage, testing, IBC, and beyond.
10+
11+
## Website
12+
313
### https://cosmwasm.github.io
14+
15+
## How is it made?
16+
17+
The deployed documentation is a [VitePress](https://vitepress.dev/) project hosted on GitHub pages.
18+
19+
## How can I run it locally?
20+
21+
You can just clone this repo and run the following commands:
22+
23+
```shell
24+
$ npm install
25+
$ task serve
26+
```
27+
28+
You will now be able to visit the locally served website at http://localhost:5173/
29+
30+
## How can I contribute?
31+
32+
Clone this repo, commit your changes to a new branch, push and open a new PR.

pages/guide/cosmwasm-core/architecture/architecture.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

pages/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ hero:
1010
actions:
1111
- theme: brand
1212
text: Welcome
13-
link: /guide/welcome
13+
link: /guide/welcome
14+
- theme: alt
15+
text: CosmWasm Core
16+
link: /guide/cosmwasm-core/introduction
1417

1518
features:
1619
- title: Security

0 commit comments

Comments
 (0)