Skip to content

Commit df7db6c

Browse files
hoffmabchoffmabc
committed
Migrate documentation to Fumadocs and update assets
Migrated Arch Network documentation from GitBook to Fumadocs, adding new MDX/Markdown content, updating the README with setup and contribution instructions, and restructuring the project for the new documentation framework. Added and reorganized static assets, updated configuration files, and removed obsolete public files. Initial content migration includes core docs, developer guides, community resources, and architecture overviews.
1 parent 4d56319 commit df7db6c

File tree

118 files changed

+15521
-1075
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+15521
-1075
lines changed

‎MIGRATION_CHECKLIST.md‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
# Arch Network Documentation Migration Checklist
2+
3+
## ✅ Completed Pages
4+
5+
### Core Pages
6+
- [x] Introduction (index.mdx)
7+
- [x] Quick Start Guide
8+
9+
### Core Concepts
10+
- [x] Architecture Overview
11+
- [x] Bitcoin Integration
12+
- [x] ROAST and FROST Consensus
13+
14+
### Program Development
15+
- [x] Writing Your First Program
16+
17+
### Arch Program Library (APL)
18+
- [x] Introduction
19+
20+
---
21+
22+
## 🚧 Pending Migration
23+
24+
### Getting Started (7 pages)
25+
- [ ] Validator Setup (bitcoin-and-titan-setup.md)
26+
- [ ] System Requirements (requirements.md)
27+
- [ ] Setup Options (how-to-configure-local-validator-bitcoin-testnet4.md)
28+
- [ ] Running Your Node (validator-staking.md)
29+
- [ ] Setting Up a Project (setting-up-a-project.md)
30+
- [ ] FAQ (faq.md)
31+
- [ ] External Resources (resources.md)
32+
33+
### Core Concepts (6 pages)
34+
- [ ] Network Architecture (network-architecture.md)
35+
- [ ] Validator State Machine (validator-state-machine.md)
36+
- [ ] Node Operation (nodes.md)
37+
- [ ] Programs (program/program.md)
38+
- [ ] UTXOs (program/utxo.md)
39+
- [ ] Accounts (program/accounts.md)
40+
- [ ] Instructions (program/instructions-and-messages.md)
41+
- [ ] System Calls (program/syscall.md)
42+
43+
### Program Development (8 pages)
44+
- [ ] Understanding Arch Programs (understanding-arch-programs.md)
45+
- [ ] Testing Your Program (testing-guide.md)
46+
- [ ] Program Examples (guides.md)
47+
- [ ] Fungible Token (how-to-create-a-fungible-token.md)
48+
- [ ] Oracle Program (how-to-write-oracle-program.md)
49+
- [ ] Runes Swap (how-to-build-runes-swap.md)
50+
- [ ] Lending Protocol (how-to-build-lending-protocol.md)
51+
52+
### Arch Program Library (APL) (6 pages)
53+
- [ ] Token Program (token-program.md)
54+
- [ ] Associated Token Account Program (associated-token-account.md)
55+
- [ ] Token API (token/api.md)
56+
- [ ] Token Architecture (token/architecture.md)
57+
- [ ] Token Security (token/security.md)
58+
- [ ] Token Usage (token/usage.md)
59+
60+
### SDK Reference (13 pages)
61+
- [ ] SDK Overview (sdk.md)
62+
- [ ] TypeScript SDK Getting Started (typescript/getting-started.md)
63+
- [ ] TypeScript API Reference (typescript/api-reference.md)
64+
- [ ] TypeScript Examples (typescript/examples.md)
65+
- [ ] Web3 Integration (typescript/web3-integration.md)
66+
- [ ] Rust SDK Getting Started (rust/getting-started.md)
67+
- [ ] Rust API Reference (rust/api-reference.md)
68+
- [ ] Rust Examples (rust/examples.md)
69+
- [ ] Program Development (rust/program-development.md)
70+
- [ ] Core Types (core-types.md)
71+
- [ ] Pubkey (pubkey.md)
72+
- [ ] Account (account.md)
73+
- [ ] Instructions and Messages (instructions-and-messages.md)
74+
- [ ] Runtime Transaction (runtime-transaction.md)
75+
- [ ] Processed Transaction (processed-transaction.md)
76+
- [ ] Signature (signature.md)
77+
78+
### Tools & CLI (1 page)
79+
- [ ] Arch CLI Reference (arch-cli-reference.md)
80+
81+
### Reference (2 pages)
82+
- [ ] API Reference (rpc/rpc.md)
83+
- [ ] RPC Method Availability (rpc/rpc-method-availability.md)
84+
85+
### System Program (5 pages)
86+
- [ ] System Program (system-program.md)
87+
- [ ] Account Creation (create-account.md)
88+
- [ ] Program Deployment (make-executable.md)
89+
- [ ] Assign Ownership (assign-ownership.md)
90+
- [ ] Write Bytes (write-bytes.md)
91+
92+
### Resources (2 pages)
93+
- [ ] Troubleshooting (troubleshooting.md)
94+
- [ ] External Resources (resources.md)
95+
96+
### RPC HTTP Methods (20 pages)
97+
- [ ] get-account-address.md
98+
- [ ] get-all-accounts.md
99+
- [ ] get-arch-txid-from-btc-txid.md
100+
- [ ] get-best-block-hash.md
101+
- [ ] get-best-finalized-block-hash.md
102+
- [ ] get-block-count.md
103+
- [ ] get-block-hash.md
104+
- [ ] get-block.md
105+
- [ ] get-current-state.md
106+
- [ ] get-latest-tx-using-account.md
107+
- [ ] get-network-pubkey.md
108+
- [ ] get-peers.md
109+
- [ ] get-processed-transaction.md
110+
- [ ] get-program-accounts.md
111+
- [ ] get-transaction-report.md
112+
- [ ] get-version.md
113+
- [ ] is-node-ready.md
114+
- [ ] read-account-info.md
115+
- [ ] reset-network.md
116+
- [ ] send-transaction.md
117+
- [ ] send-transactions.md
118+
- [ ] start-dkg.md
119+
120+
### Additional Files
121+
- [ ] Basics (basics/basics.md)
122+
- [ ] Building Deploying Interfacing (basics/building-deploying-interfacing.md)
123+
- [ ] Interaction (basics/interaction.md)
124+
- [ ] APL Token Standard (apl-token-standard.md)
125+
- [ ] Whitepaper PDF (whitepaper.pdf)
126+
127+
---
128+
129+
## 📊 Migration Progress
130+
131+
**Total Pages**: ~80 pages
132+
**Completed**: 5 pages (6.25%)
133+
**Remaining**: ~75 pages (93.75%)
134+
135+
## 🎯 Priority Order
136+
137+
1. **High Priority** (Core functionality)
138+
- Getting Started pages
139+
- Core Concepts remaining pages
140+
- Program Development guides
141+
142+
2. **Medium Priority** (Developer tools)
143+
- SDK Reference
144+
- APL documentation
145+
- Tools & CLI
146+
147+
3. **Low Priority** (Reference material)
148+
- RPC API methods
149+
- System Program details
150+
- Additional resources
151+
152+
## 📝 Notes
153+
154+
- All Mermaid diagrams are working correctly
155+
- Images have been copied to public/images/
156+
- Navigation structure is set up in meta.json
157+
- Build and deployment are working
158+
- Ready for Vercel deployment

‎README.md‎

Lines changed: 130 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,146 @@
1-
# Arch Official Documentation
1+
# Arch Network Documentation - Fumadocs
22

3-
Welcome to the official documentation repository for Arch Network.
3+
This repository contains the Arch Network documentation migrated from GitBook to Fumadocs, a modern React-based documentation framework.
44

5-
Within this repository there are resources for learning more about Arch, its mission and what resources are available for both builders as well as validators looking to run nodes for Arch.
5+
## 🚀 Quick Start
66

7-
### Requirements
7+
### Prerequisites
88

9-
Building the site requires [yarn](https://yarnpkg.com/getting-started/install)
9+
- Node.js v19+
10+
- npm or yarn
11+
12+
### Installation
1013

11-
### Build
1214
```bash
13-
yarn docs:build
15+
# Clone the repository
16+
git clone https://github.com/Arch-Network/docs-fumadocs.git
17+
cd docs-fumadocs
18+
19+
# Install dependencies
20+
npm install
21+
22+
# Start development server
23+
npm run dev
1424
```
1525

16-
### Serve
26+
The documentation will be available at `http://localhost:3000`.
27+
28+
### Building for Production
1729

1830
```bash
19-
yarn docs:dev
31+
npm run build
32+
npm start
33+
```
34+
35+
## 📁 Project Structure
36+
37+
```
38+
docs-fumadocs/
39+
├── content/
40+
│ └── docs/ # Documentation content (MDX files)
41+
│ ├── getting-started/ # Getting started guides
42+
│ ├── concepts/ # Core concepts
43+
│ ├── guides/ # Development guides
44+
│ ├── sdk/ # SDK documentation
45+
│ ├── rpc/ # RPC API reference
46+
│ └── meta.json # Navigation structure
47+
├── src/
48+
│ ├── app/ # Next.js app directory
49+
│ ├── lib/ # Utility functions
50+
│ └── mdx-components.tsx # MDX component overrides
51+
├── public/
52+
│ └── images/ # Static assets
53+
└── package.json
2054
```
2155

22-
This documentation site is built with [VitePress](https://vitepress.dev)
56+
## 📝 Content Migration Status
57+
58+
### ✅ Completed
59+
- [x] Project setup and configuration
60+
- [x] Main introduction page
61+
- [x] Quick start guide
62+
- [x] Architecture overview
63+
- [x] Basic navigation structure
64+
- [x] Image assets migration
65+
66+
### 🚧 In Progress
67+
- [ ] Theme customization for Arch Network branding
68+
- [ ] Additional content migration from GitBook
69+
- [ ] Search functionality optimization
70+
- [ ] Mobile responsiveness improvements
71+
72+
### 📋 Pending
73+
- [ ] Complete migration of all GitBook content
74+
- [ ] API reference documentation
75+
- [ ] SDK documentation
76+
- [ ] Program examples and guides
77+
- [ ] System program documentation
78+
79+
## 🎨 Customization
80+
81+
### Theme Customization
82+
83+
The Fumadocs theme can be customized by modifying:
84+
85+
- `src/app/global.css` - Global styles
86+
- `src/lib/layout.shared.tsx` - Shared layout components
87+
- `content/docs/meta.json` - Navigation structure
88+
89+
### Adding New Content
90+
91+
1. Create MDX files in the appropriate directory under `content/docs/`
92+
2. Update `content/docs/meta.json` to include the new pages in navigation
93+
3. Use Fumadocs components like `<Cards>`, `<Card>`, `<Callout>`, etc.
94+
95+
### MDX Components Available
96+
97+
- `<Cards>` and `<Card>` - For creating card layouts
98+
- `<Callout>` - For info, warning, and tip callouts
99+
- `<Tabs>` and `<Tab>` - For tabbed content
100+
- `<Steps>` and `<Step>` - For step-by-step guides
101+
102+
## 🔧 Development
103+
104+
### Available Scripts
105+
106+
- `npm run dev` - Start development server
107+
- `npm run build` - Build for production
108+
- `npm run start` - Start production server
109+
- `npm run lint` - Run ESLint
110+
111+
### Key Features
112+
113+
- **Modern React Framework**: Built with Next.js 15 and React 19
114+
- **MDX Support**: Write documentation with JSX components
115+
- **Type Safety**: Full TypeScript support
116+
- **Search**: Built-in search functionality
117+
- **Responsive Design**: Mobile-first responsive design
118+
- **Dark Mode**: Automatic dark/light mode support
119+
120+
## 📚 Migration from GitBook
121+
122+
This documentation was migrated from the original GitBook repository. Key changes:
123+
124+
1. **Format**: Converted from Markdown to MDX for enhanced functionality
125+
2. **Components**: Replaced GitBook-specific components with Fumadocs equivalents
126+
3. **Navigation**: Restructured navigation using Fumadocs meta.json format
127+
4. **Styling**: Updated to use Tailwind CSS and Fumadocs design system
128+
129+
## 🤝 Contributing
130+
131+
1. Fork the repository
132+
2. Create a feature branch
133+
3. Make your changes
134+
4. Test locally with `npm run dev`
135+
5. Submit a pull request
23136

24-
### Directory Structure
137+
## 📄 License
25138

26-
- /learn: A category for learning about Arch Network.
27-
- /developers: Resources for understanding, building and deploying Arch programs (smart contracts).
28-
- /nodes: Technical resources for node operators.
29-
- /community: Resources for connecting with the Arch community.
30-
- /public: Media.
139+
This documentation is part of the Arch Network project and follows the same licensing terms.
31140

32-
### Feedback & Suggestions
141+
## 🔗 Links
33142

34-
We value feedback from the community. If you have suggestions for improvements or find any bugs in the documentation, please open an [issue](https://github.com/Arch-Network/docs/issues) or [PR](https://github.com/Arch-Network/docs/pulls).
143+
- [Arch Network Main Repository](https://github.com/Arch-Network/arch-network)
144+
- [Original GitBook Documentation](https://github.com/Arch-Network/book)
145+
- [Fumadocs Documentation](https://fumadocs.dev/)
146+
- [Arch Network Website](https://arch.network)

‎content/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.vercel

‎content/community/overview.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Community
3+
---
4+
5+
This section highlights the different resources for the Arch community.
6+
7+
- [Discord](https://discord.gg/archnetwork)
8+
- [Twitter](https://twitter.com/ArchNtwrk)
9+
- [Medium](https://medium.com/arch-network)
10+
- [Arch Network Builders Form]
11+
- [Arch Network Validators Form]
12+
13+
[Arch Network Builders Form]: https://0chrcuqp28m.typeform.com/to/fTaRfve6?typeform-source=www.arch.network
14+
[Arch Network Validators Form]: https://0chrcuqp28m.typeform.com/validator-apply?typeform-source=www.arch.network

0 commit comments

Comments
 (0)