Skip to content

TribeWarez/docs.tribewarez.com

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docs.tribewarez.com

Public documentation site for the TribeWarez blockchain ecosystem, built with VitePress.

Live: https://docs.tribewarez.com

Sections

Section Path Content
Chain /chain/ Solana testnet, EVM testnet, RPC proxy, status API
PoT-O /pot-o/ Proof of Tensor Optimizations — mining, ESP devices, pool strategies, API
Tokens /tokens/ PTtC, NMTC, token economics
DeFi /defi/ Staking, swap (AMM), vault/escrow programs
Programs /programs/ Anchor on-chain program reference (staking, swap, vault, pot-o)
Infrastructure /infrastructure/ Docker Compose setup, nginx-proxy routing, deployment
Apps /apps/ Terminal, DeFi Portal, Mystic Numbers, Numerology Wars, Serverz, Hub, DIE-Mining

Quick Start

npm install
npm run docs:dev

Opens the dev server at http://localhost:5173 with hot reload.

Scripts

Command Description
npm run docs:dev Start dev server with hot reload
npm run docs:build Build static site to docs/.vitepress/dist/
npm run docs:preview Preview the built site locally

Project Structure

docs.tribewarez.com/
├── package.json
├── Dockerfile
├── nginx.conf
└── docs/
    ├── index.md                  # Home (hero layout)
    ├── getting-started.md        # Quick start guide
    ├── .vitepress/
    │   ├── config.ts             # VitePress config (nav, sidebar, search)
    │   └── theme/
    │       ├── index.ts          # Extends DefaultTheme
    │       └── custom.css        # Brand colors (emerald green)
    ├── chain/                    # Chain & RPC docs
    ├── pot-o/                    # Proof of Tensor Optimizations
    ├── tokens/                   # PTtC, NMTC, token economics
    ├── defi/                     # Staking, swap, vault
    ├── programs/                 # Anchor program reference
    ├── infrastructure/           # Docker, proxy, deployment
    └── apps/                     # Terminal, DeFi Portal, Mystic Numbers, etc.

Docker

The site ships as a static Nginx container:

docker build -t docs-tribewarez .
docker run -p 8080:80 docs-tribewarez

The Dockerfile uses a two-stage build:

  1. Build — Node 20 Alpine, npm install, npm run docs:build
  2. Servenginx:alpine serving docs/.vitepress/dist/ with SPA fallback, asset caching, and 404 handling

In production, the container is routed via VIRTUAL_HOST=docs.tribewarez.com through the nginx-proxy reverse proxy defined in the root docker-compose.yml.

Adding Pages

  1. Create a Markdown file under docs/<section>/ (e.g. docs/apps/new-app.md)
  2. Add a sidebar entry in docs/.vitepress/config.ts under the matching section
  3. Run npm run docs:dev to preview
  4. Commit and rebuild the Docker image

Tech Stack

  • VitePress 1.6 — Vue-powered static site generator
  • Default theme with custom CSS (emerald green brand palette)
  • Local search — built-in VitePress search provider
  • Nginx — production static file server
  • Docker — containerized deployment

About

No description or website provided.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors