Skip to content

Commit 8291849

Browse files
Merge pull request #32 from AnilChinchawale/feature/update-navigation
docs: update mkdocs.yml navigation structure
2 parents 4b99edc + 6dedfc8 commit 8291849

1 file changed

Lines changed: 110 additions & 0 deletions

File tree

mkdocs-nav-update.yml

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# PROPOSED NAVIGATION UPDATE FOR mkdocs.yml
2+
# This file shows the new nav structure to add
3+
# Merge this into the existing mkdocs.yml nav section
4+
5+
nav:
6+
- Home: index.md
7+
8+
# NEW: Learn Section (for newcomers)
9+
- Learn:
10+
- Overview: ./learn/index.md
11+
- Blockchain Basics: ./learn/blockchain-basics.md
12+
- XDC Architecture: ./learn/xdc-architecture.md
13+
- XDPoS Explained: ./learn/xdpos-explained.md
14+
- Gas & Fees: ./learn/gas-fees.md
15+
- Glossary: ./learn/glossary.md
16+
- FAQ: ./learn/faq.md
17+
18+
- XDC Chain:
19+
- XDC Chain Overview: ./xdcchain/index.md
20+
- XDPoS Consensus: ./xdcchain/xdpos.md
21+
- XDPoS 2.0: ./xdcchain/xdpos2.md
22+
- XDC Ecosystem: https://xinfin.org/ecosystem-dapps
23+
- Developers:
24+
- Quick Guide: ./xdcchain/developers/quick-guide.md
25+
- USDC Quickstart: ./xdcchain/developers/usdc-quickstart.md
26+
- Dev-Tools: https://xinfin.org/quick-tools-guide
27+
- RPC Endpoints:
28+
- RPC: ./xdcchain/developers/rpc.md
29+
- Mainnet RPC: ./xdcchain/developers/mainnetrpc.md
30+
- Apothem Testnet RPC: ./xdcchain/developers/apothemrpc.md
31+
- Devnet RPC: ./xdcchain/developers/devnetrpc.md
32+
- Faucet: https://faucet.blocksscan.io/
33+
- Migrating from EVM to XDC: ./xdcchain/evmtoxdc.md
34+
- Wallet Configuration: ./xdcchain/developers/wallet-configuration.md
35+
- Get XDC Listed: ./xdcchain/developers/getxdclisted.md
36+
- XDC2.0 Private Network: ./xdcchain/developers/xdposchain_privatenet.md
37+
38+
- Node Operators:
39+
- Node Architecture: ./xdcchain/developers/node_operators/node_architecture.md
40+
- Rewards Mechanism: ./xdcchain/rewards.md
41+
- Masternode Setup: ./xdcchain/developers/node_operators/masternode.md
42+
- Docker Image: ./xdcchain/developers/node_operators/dockerimg.md
43+
- Slashing: ./xdcchain/developers/node_operators/slashing.md
44+
45+
- Governance:
46+
- Overview of XDCDAO: ./xdcchain/governance/overview.md
47+
48+
- FAQ: ./xdcchain/faq.md
49+
50+
- XDC Subnet:
51+
- Overview:
52+
- Design and Architecture: ./subnet/overview.md
53+
- Components:
54+
- Subnet Chain: ./subnet/components/subnet_chain.md
55+
- Checkpoint Smart Contract: ./subnet/components/checkpoint_contract.md
56+
- Relayer: ./subnet/components/relayer.md
57+
- API Library: ./subnet/components/api_library.md
58+
- XDCZero: ./subnet/components/xdc_zero.md
59+
- Subswap: ./subnet/components/subswap.md
60+
61+
- Deployment and Usage:
62+
- Deployment Guide:
63+
- Launch a Subnet: ./subnet/install_guide/launch_subnet.md
64+
- Multi-Machines Deployment: ./subnet/install_guide/multi_machines_deployment.md
65+
- Exposing Subnet Frontend: ./subnet/install_guide/exposing_services_frontend.md
66+
- Configs Explanation: ./subnet/install_guide/config_explanation.md
67+
- Common Issues: ./subnet/install_guide/common_issues.md
68+
- FAQ: ./subnet/install_guide/faq.md
69+
70+
- Using the Subnet:
71+
- UI Usage Guide: ./subnet/using_subnet/using_subnet.md
72+
- Faucet: ./subnet/using_subnet/faucet.md
73+
- Block Explorer: ./subnet/using_subnet/explorer.md
74+
- Upgrading the Subnet: ./subnet/upgrading_subnet.md
75+
76+
- Resources:
77+
- GitHub Repositories: ./subnet/resources/repos.md
78+
- Changelog: ./subnet/resources/changelog.md
79+
- Contact: ./subnet/contact.md
80+
81+
# NEW: Enterprise Section
82+
- Enterprise:
83+
- Overview: ./enterprise/index.md
84+
- Trade Finance: ./enterprise/trade-finance.md
85+
- RWA Tokenization: ./enterprise/rwa-tokenization.md
86+
- ISO 20022 Integration: ./enterprise/iso-20022.md
87+
- Private Subnets: ./enterprise/private-subnets.md
88+
89+
# NEW: API Reference Section
90+
- API Reference:
91+
- Overview: ./api/index.md
92+
- JSON-RPC: ./api/json-rpc.md
93+
- WebSocket: ./api/websocket.md
94+
- Error Codes: ./api/error-codes.md
95+
96+
- Smart Contracts:
97+
- Overview: ./smartcontract/index.md
98+
- Deployment & Verification: ./smartcontract/deployment-verification.md
99+
- Flattening Contracts: ./smartcontract/flattening-smart-contracts.md
100+
- Token Standards:
101+
- Overview: ./smartcontract/tokens.md
102+
- XRC20: ./smartcontract/tokens.md#xrc20
103+
- XRC721: ./smartcontract/tokens.md#xrc721
104+
- XRC404: ./smartcontract/tokens.md#xrc404
105+
- XDC Stats: ./smartcontract/xdcstats.md
106+
- Data & Analytics: ./smartcontract/data-analytics.md
107+
108+
- Announcements: ./announce/index.md
109+
110+
- White Paper: whitepaper.md

0 commit comments

Comments
 (0)