Skip to content

Reorganize subnet docs #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AnilChinchawale merged 1 commit into from
Nov 26, 2025
Merged

Reorganize subnet docs #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions docs/subnet/components/repos.md
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions docs/subnet/components/subnet_generator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder
11 changes: 11 additions & 0 deletions docs/subnet/index.md → docs/subnet/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,14 @@ The architecture consists of the following key components owned by the customer:

![subnet-image](./img/xdc-subnet-architecture.svg)


<div class="section-body">
<a href="../components/subnet_chain/" class="grid-item">
Copy link

@coderabbitai coderabbitai bot Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify relative navigation paths resolve correctly.

The navigation tiles use relative paths (../components/subnet_chain/ and ../install_guide/launch_subnet/) to link to subnet documentation. Confirm these paths resolve correctly in the generated MkDocs site based on the restructured navigation hierarchy.

Run the following script to verify the markdown files exist and path references are valid:

Also applies to: 47-47

🏁 Script executed:

#!/bin/bash
# Description: Verify that referenced files exist and check mkdocs structure

# Check if referenced markdown files exist
echo "Checking referenced files..."
test -f docs/subnet/components/subnet_chain.md && echo "✓ Subnet Chain file exists" || echo "✗ Subnet Chain file NOT found"
test -f docs/subnet/install_guide/launch_subnet.md && echo "✓ Launch Subnet file exists" || echo "✗ Launch Subnet file NOT found"

# Check mkdocs.yml navigation structure for path consistency
echo -e "\nChecking mkdocs.yml references..."
grep -n "subnet_chain.md\|launch_subnet.md" mkdocs.yml

Length of output: 253

Fix relative navigation paths to use correct directory traversal.

The relative paths use ../ which incorrectly navigate to the root level instead of staying within the subnet directory. Update lines 43 and 47 to use ./ prefix:

  • Line 43: Change ../components/subnet_chain/ to ./components/subnet_chain/
  • Line 47: Change ../install_guide/launch_subnet/ to ./install_guide/launch_subnet/

From the generated MkDocs site at /subnet/overview/, the ../ prefix goes up to the root level, causing links to resolve to /components/subnet_chain/ and /install_guide/launch_subnet/ instead of /subnet/components/subnet_chain/ and /subnet/install_guide/launch_subnet/. The ./ prefix correctly keeps navigation within the subnet namespace.

🤖 Prompt for AI Agents 
In docs/subnet/overview.md around lines 43 and 47, the relative links use "../"
which climbs to the site root and produces incorrect URLs; change line 43 from
"../components/subnet_chain/" to "./components/subnet_chain/" and line 47 from
"../install_guide/launch_subnet/" to "./install_guide/launch_subnet/" so the
links remain under the /subnet/ namespace and resolve to
/subnet/components/subnet_chain/ and /subnet/install_guide/launch_subnet/.

<div>Components</div>
<p>Continue reading on individual components of the Subnet architecture</p>
</a>
<a href="../install_guide/launch_subnet/" class="grid-item">
<div>Launch a Subnet in 10 Minutes</div>
<p>Start your own Subnet with our intuitive and easy to use Deployment Wizard</p>
</a>
</div>
18 changes: 18 additions & 0 deletions docs/subnet/install_guide/changelog.md → docs/subnet/resources/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ title: Changelog

# Subnet Deployment Generator Changelog

### [v2.1.0](https://github.com/XinFinOrg/Subnet-Deployment/releases/tag/v2.1.0) - 2025/09/23
- New XDPoS Generator - Added complete XDPoS (XinFin Delegated Proof of Stake) subnet deployment support with dedicated web interface and generation module
- Deployment Wizard - New user-friendly interface for configuring and managing XDPoS-based subnets
- Enhanced Docker Scripts - Improved startup and shutdown procedures for better container management
- Expanded API - Added XDPoS-specific endpoints to Express server
- Execution Library - New utilities for enhanced command execution and process management
- Versioning Fixes - Resolved version display and handling issues across configuration files

### [v2.0.0](https://github.com/XinFinOrg/Subnet-Deployment/releases/tag/v2.0.0) - 2025/09/23
- Container Manager System - Complete containerized deployment solution with Express.js web server, real-time state monitoring, and Docker orchestration
- Interactive Web UI - Modern interface with real-time state detection, dynamic controls, command streaming, and auto-collapsing history
- Comprehensive Generators - Automated generation of configurations, docker-compose files, environment variables, and helper scripts
- Faucet System - Integrated faucet server with dedicated web interface for token distribution
- Advanced State Management - Real-time monitoring of blocks, peers, contracts, and mining status
- Utility Scripts - node addition script, mining checks, peer monitoring, and docker management tools
- Refactored Codebase - Major improvements to deployment-generator with cleaner architecture


### v1.0.0 - 2024/10/03
- Added Configuration Generator UI
- Added XDC-Zero configuration generation
Expand Down
17 changes: 17 additions & 0 deletions docs/subnet/resources/repos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Repos
---

## Subnet Repositories

Subnet Generator/Deployment Wizard: https://github.com/XinFinOrg/Subnet-Deployment

Subnet Blockchain Node: https://github.com/XinFinOrg/XDC-Subnet

Relayer: https://github.com/XinFinOrg/XDC-Relayer

Checkpoint Smart Contract (CSC): https://github.com/XinFinOrg/XDC-CSC

XDC-Zero Cross-chain Framework: https://github.com/XinFinOrg/XDC-Zero

Subnet UI: https://github.com/XinFinOrg/subnet-stats-service
Comment on lines +7 to +17
Copy link

@coderabbitai coderabbitai bot Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Wrap bare URLs with markdown link syntax.

All repository URLs are flagged by markdownlint (MD034) as bare URLs. Wrap them in markdown link syntax to comply with linting standards.

Apply this diff to wrap URLs as proper markdown links:

## Subnet Repositories

-Subnet Generator/Deployment Wizard: https://github.com/XinFinOrg/Subnet-Deployment
+[Subnet Generator/Deployment Wizard](https://github.com/XinFinOrg/Subnet-Deployment)

-Subnet Blockchain Node: https://github.com/XinFinOrg/XDC-Subnet
+[Subnet Blockchain Node](https://github.com/XinFinOrg/XDC-Subnet)

-Relayer: https://github.com/XinFinOrg/XDC-Relayer
+[Relayer](https://github.com/XinFinOrg/XDC-Relayer)

-Checkpoint Smart Contract (CSC): https://github.com/XinFinOrg/XDC-CSC
+[Checkpoint Smart Contract (CSC)](https://github.com/XinFinOrg/XDC-CSC)

-XDC-Zero Cross-chain Framework: https://github.com/XinFinOrg/XDC-Zero
+[XDC-Zero Cross-chain Framework](https://github.com/XinFinOrg/XDC-Zero)

-Subnet UI: https://github.com/XinFinOrg/subnet-stats-service
+[Subnet UI](https://github.com/XinFinOrg/subnet-stats-service)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Subnet Generator/Deployment Wizard: https://github.com/XinFinOrg/Subnet-Deployment
Subnet Blockchain Node: https://github.com/XinFinOrg/XDC-Subnet
Relayer: https://github.com/XinFinOrg/XDC-Relayer
Checkpoint Smart Contract (CSC): https://github.com/XinFinOrg/XDC-CSC
XDC-Zero Cross-chain Framework: https://github.com/XinFinOrg/XDC-Zero
Subnet UI: https://github.com/XinFinOrg/subnet-stats-service
[Subnet Generator/Deployment Wizard](https://github.com/XinFinOrg/Subnet-Deployment)
[Subnet Blockchain Node](https://github.com/XinFinOrg/XDC-Subnet)
[Relayer](https://github.com/XinFinOrg/XDC-Relayer)
[Checkpoint Smart Contract (CSC)](https://github.com/XinFinOrg/XDC-CSC)
[XDC-Zero Cross-chain Framework](https://github.com/XinFinOrg/XDC-Zero)
[Subnet UI](https://github.com/XinFinOrg/subnet-stats-service)
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

7-7: Bare URL used

(MD034, no-bare-urls)

9-9: Bare URL used

(MD034, no-bare-urls)

11-11: Bare URL used

(MD034, no-bare-urls)

13-13: Bare URL used

(MD034, no-bare-urls)

15-15: Bare URL used

(MD034, no-bare-urls)

17-17: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents 
In docs/subnet/resources/repos.md around lines 7 to 17, the listed repository
URLs are bare and trigger markdownlint MD034; wrap each URL in markdown link
syntax by replacing plain URLs with the format [Repository Name](https://...)
for each entry (e.g., Subnet Generator/Deployment Wizard -> [Subnet
Generator/Deployment Wizard](https://github.com/XinFinOrg/Subnet-Deployment)),
doing the same for Subnet Blockchain Node, Relayer, Checkpoint Smart Contract
(CSC), XDC-Zero Cross-chain Framework, and Subnet UI so all links comply with
linting.

25 changes: 15 additions & 10 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,17 @@ nav:
- FAQs: ./xdcchain/faq.md

- XDC Subnet:
- XDC Subnet:
- Introduction: ./subnet/index.md
- Overview:
- Design and Architecture: ./subnet/overview.md
- Components:
- Subnet Chain: ./subnet/components/subnet_chain.md
- Checkpoint Smart Contract: ./subnet/components/checkpoint_contract.md
- Relayer: ./subnet/components/relayer.md
- API Library: ./subnet/components/api_library.md
- XDCZero: ./subnet/components/xdc_zero.md
- Subswap: ./subnet/components/subswap.md

- Deployment and Usage:
- Deployment Guide:
- Launch a Subnet: ./subnet/install_guide/launch_subnet.md
- Multi-Machines Deployment: ./subnet/install_guide/multi_machines_deployment.md
Expand All @@ -123,14 +132,10 @@ nav:
- Faucet: ./subnet/using_subnet/faucet.md
- Block Explorer: ./subnet/using_subnet/explorer.md
- Upgrading the Subnet: ./subnet/upgrading_subnet.md
- Components:
- Subnet Chain: ./subnet/components/subnet_chain.md
- Checkpoint Smart Contract: ./subnet/components/checkpoint_contract.md
- Relayer: ./subnet/components/relayer.md
- API Library: ./subnet/components/api_library.md
- XDCZero: ./subnet/components/xdc_zero.md
- Subswap: ./subnet/components/subswap.md
- Repositories: ./subnet/components/repos.md

- Resources:
- GitHub Repositories: ./subnet/resources/repos.md
- Changelog: ./subnet/resources/changelog.md
- Contact: ./subnet/contact.md

- Announcements:
Expand Down