Merge pull request #9 from Endogen/main

Updated documentation

.vitepress/config.mts

@@ -31,40 +31,49 @@ export default defineConfig({
                         text: 'Smart Contracts',
                         collapsed: true,
                         items: [
-                            { text: 'Contracting Engine', link: '/smart-contracts/' },
-                            { text: 'Cheat Sheet', link: '/smart-contracts/contract-cheat-sheet' },
-                            { text: 'Context', link: '/smart-contracts/context' },
-                            { text: 'Functions', link: '/smart-contracts/functions' },
-                            { text: 'Events', link: '/smart-contracts/events' },
+                            { text: 'Contracting Engine', link: '/contracts/' },
+                            { text: 'Cheat Sheet', link: '/contracts/cheat-sheet' },
+                            { text: 'Context', link: '/contracts/context' },
+                            { text: 'Functions', link: '/contracts/functions' },
+                            { text: 'Events', link: '/contracts/events' },
                             { text: 'Modules', collapsed: true, items: [
-                                    { text: 'Crypto', link: '/smart-contracts/modules/crypto-stdlib' },
-                                    { text: 'Hashlib', link: '/smart-contracts/modules/hashlib-stdlib' },
-                                    { text: 'Random', link: '/smart-contracts/modules/random-stdlib' },
-                                    { text: 'Storage', link: '/smart-contracts/modules/storage' },
-                                    { text: 'Datetime', link: '/smart-contracts/modules/datetime-stdlib' },
+                                    { text: 'Crypto', link: '/contracts/modules/crypto-stdlib' },
+                                    { text: 'Hashlib', link: '/contracts/modules/hashlib-stdlib' },
+                                    { text: 'Random', link: '/contracts/modules/random-stdlib' },
+                                    { text: 'Datetime', link: '/contracts/modules/datetime-stdlib' },
                                 ]
                             },
                             {
                                 text: 'Concepts',
                                 collapsed: true,
                                 items: [
-                                    { text: 'Stamps', link: '/smart-contracts/concepts/stamps' },
-                                    { text: 'Valid Code', link: '/smart-contracts/concepts/valid-code' },
-                                    { text: 'Contract Submission', link: '/smart-contracts/concepts/contract-submission' },
-                                    { text: 'Model', link: '/smart-contracts/concepts/model' },
+                                    { text: 'Stamps', link: '/contracts/concepts/stamps' },
+                                    { text: 'Storage', link: '/contracts/concepts/storage' },
+                                    { text: 'Valid Code', link: '/contracts/concepts/valid-code' },
+                                    { text: 'Contract Submission', link: '/contracts/concepts/contract-submission' },
+                                    { text: 'Model', link: '/contracts/concepts/model' },
                                 ]
                             },
-                            { text: 'Testing', link: '/smart-contracts/testing' },
+                            {
+                                text: 'Standards',
+                                collapsed: true,
+                                items: [
+                                    { text: 'XSC0001', link: '/contracts/standards/xsc0001' },
+                                    { text: 'XSC0002', link: '/contracts/standards/xsc0002' },
+                                    { text: 'XSC0003', link: '/contracts/standards/xsc0003' },
+                                ]
+                            },
+                            { text: 'Testing', link: '/contracts/testing' },
                             {
                                 text: 'Examples',
                                 collapsed: true,
                                 items: [
                                     { text: 'Overview', link: '/examples/' },
-                                    { text: 'Uber Dice', link: '/examples/uber-dice-example' },
+                                    { text: 'Uber Dice', link: '/examples/uber-dice' },
                                     { text: 'Token XSC003', link: '/examples/currency' },
                                 ]
                             },
-                            { text: "Submitting a Contract", link: "/smart-contracts/submitting-a-contract" }
+                            { text: "Submitting a Contract", link: "/contracts/submitting-a-contract" }
                         ]
                     },
                     {

README.md

@@ -1,21 +1,39 @@
-# Docs Readme
+# Xian Documentation
+
+Documentation for the Xian blockchain platform.
+
+## Quick Start
+
+### Requirements
+- Node.js >= 18
+- npm/yarn
 
-## Quickstart
 ### Setup
-```bash
-git clone https://github.com/xian-network/vitepress.git
-cd vitepress
+```
+git clone https://github.com/xian-network/docs.git
+cd docs
 npm install
 ```
+
 ### Development
-```bash
+```
 npm run dev
 ```
+Server starts at `http://localhost:5173`
 
-### Build
-- Github actions automatically builds & publishes
-- But if you must ...
-```bash
-npm run build
-npm run preview
-```
+### Content Structure
+```
+xian-docs/
+├── .vitepress/    # Contains config.mts for navigation/sections
+└── src/           # Documentation source files
+```
+**Note: New sections must be added to .vitepress/config.mts**
+
+### Building
+Documentation is auto-built and deployed via GitHub Actions on push to main.
+
+For local builds:
+```
+npm run build    # Build static site
+npm run preview  # Preview built site
+```