Skip to content

Restructure network documentation for Ethereum L2 migration#127

Merged
kingsleydon merged 4 commits intomainfrom
update-network-docs-structure
Nov 21, 2025
Merged

Restructure network documentation for Ethereum L2 migration#127
kingsleydon merged 4 commits intomainfrom
update-network-docs-structure

Conversation

@kingsleydon
Copy link
Copy Markdown
Contributor

@kingsleydon kingsleydon commented Nov 21, 2025

Summary

This PR restructures the network documentation to reflect Phala Network's migration from Parachain to Ethereum L2 with GPU-based compute providers.

Key Changes

📁 New Documentation Structure

  • Overview Section (/network/overview/):

    • Added 6 new pages covering network basics, staking, governance, treasury, token transfers, and block explorers
    • Focused on the new Ethereum L2 architecture
    • Pages ordered according to the specified numbering scheme (2.1-2.6)
  • Compute Providers (/network/compute-providers/):

    • New comprehensive introduction covering GPU mining, tokenomics, vPHA mechanics, and reward distribution
    • GPU deployment guides with step-by-step instructions (3.2.1)
    • On-chain registration documentation (3.2.2)

🗑️ Removed Legacy Content

  • Removed 45 old files related to parachain-specific infrastructure:
    • SGX workers, PRB deployment, gatekeeper setup (8+2+7 files)
    • Old blockchain tech specs (4 files)
    • Outdated reference materials (26 files)

🔄 Redirects (129 rules updated)

All removed pages now redirect to appropriate new locations:

  • 45 new redirects for deleted network documentation
  • 82 fixed redirects that were pointing to non-existent pages
  • 1 uncovered link redirect added
  • 1 compute-providers parent redirect

Redirect destinations:

  • Old compute provider pages → New GPU deployment guides or introduction
  • Old reference pages → /network/index or corresponding new sections
  • Old basic-guidance pages → /network/overview/get-pha-and-transfer
  • Old gatekeeper pages → /network/compute-providers/introduction

📚 Legacy Documentation Preserved

Old parachain documentation remains accessible under "Legacy Parachain Documentation" group for historical reference.

Impact

  • Deletions: 4,564 lines removed
  • Additions: 998 lines added
  • Net change: -3,566 lines (cleaner, more focused documentation)
  • Files changed: 54 files

Navigation Structure

Network (1)
├── Overview (2)
│   ├── Phala Network (2.1)
│   ├── Get PHA and Transfer (2.2)
│   ├── Block Explorers (2.3)
│   ├── Phala Staking (2.4)
│   ├── Phala Treasury (2.5)
│   ├── Phala Governance (2.6)
│   └── Legacy Parachain Documentation
└── Compute Providers (3)
    ├── Introduction (3.1)
    └── Run GPU on Phala (3.2)
        ├── GPU Deployment Guide (3.2.1)
        └── Register Work On-chain (3.2.2)

Testing Checklist

  • All new pages render correctly
  • Navigation structure follows numbering scheme
  • All 129 redirects point to valid destinations
  • No invalid redirect warnings
  • No uncovered link warnings
  • Legacy documentation remains accessible

Commits

  1. 2c3c980 - Restructure network documentation for Ethereum L2 migration
  2. 6bd6426 - Reorder navigation structure based on numbering scheme
  3. 2002944 - Fix invalid redirects to point to existing pages (82 fixes)
  4. fceb2b1 - Add redirect for uncovered gatekeeper link

🤖 Generated with Claude Code

kingsleydon and others added 4 commits November 20, 2025 23:44
This commit updates the network documentation structure to reflect the migration from Phala Parachain to Ethereum L2 with GPU-based compute providers.

## Changes:

### Navigation Structure
- Added new `/network/overview/` section with key pages:
  - phala-network: Core network overview
  - phala-staking: Staking information for the new L2
  - phala-governance: Governance mechanisms
  - phala-treasury: Treasury details
  - get-pha-and-transfer: Token acquisition guide
  - block-explorers: Explorer resources

### Compute Providers
- Simplified structure focusing on GPU compute:
  - Added `introduction.mdx`: Comprehensive guide on GPU mining, tokenomics, vPHA, and reward mechanisms
  - Added `run-GPU-on-phala/`: New directory for GPU deployment
    - `gpu-deployment-guide.mdx`: Step-by-step GPU deployment instructions
    - `register-work-onchain.mdx`: On-chain registration guide

### Removed Legacy Content
- Removed old parachain-specific documentation:
  - basic-info/ (8 files)
  - gatekeeper/ (2 files)
  - run-workers-on-phala/ (7 files)
  - tech-specs/blockchain/ (4 files)
  - references/ subdirectories (26 files)

### Redirects
- Added 45 new redirect rules to ensure seamless user experience:
  - Old compute-provider pages → new GPU deployment guides
  - Old reference pages → network index or corresponding new pages
  - Special redirects for block-explorers and token transfer guides

### Legacy Documentation
- Preserved old parachain documentation under "Legacy Parachain Documentation" group for reference

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Adjusted the order of pages in the Overview section to match the specified numbering:
- 2.1: phala-network
- 2.2: get-pha-and-transfer
- 2.3: block-explorers
- 2.4: phala-staking
- 2.5: phala-treasury
- 2.6: phala-governance

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Updated 82 redirect rules to point to valid destinations:
- Old archived-projects, references, tech-specs pages → /network/index
- Old compute-provider pages → /network/compute-providers/introduction or GPU guides
- Old basic-guidance pages → /network/overview/get-pha-and-transfer
- Old khala worker pages → /network/compute-providers/run-GPU-on-phala/gpu-deployment-guide

This fixes all validation errors where redirects were pointing to non-existent pages.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Added redirect from /network/compute-providers/gatekeeper to /network/compute-providers/introduction to fix the uncovered link warning.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@kingsleydon kingsleydon merged commit e7c2b53 into main Nov 21, 2025
3 checks passed
@kingsleydon kingsleydon deleted the update-network-docs-structure branch November 21, 2025 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant