Open Hand Documentation

This repository contains the source code for the TetherIA Open Hand documentation website, built with Docusaurus and deployed automatically with Netlify.

The site is live at: https://docs.tetheria.ai

---

📋 Table of Contents

1. Getting Started
2. Preview the Website Locally
3. Making Changes to the Documentation
4. Submitting Changes (Pull Requests)
5. Validating with Netlify Preview
6. Deployment
7. Summary Workflow
8. Advanced Configuration

---

1. Getting Started

Prerequisites

You only need to install Node.js and npm once.

Install Node.js (v18 or later)

• Download from: nodejs.org
• On Mac with Homebrew: brew install node

Verify installation:

node -v
npm -v

✅ You should see version numbers.

Install Dependencies

Clone the repo and install:

git clone https://github.com/TetherIA/open-hand-doc.git
cd open-hand-doc
npm install

📸 Example terminal output:

---

2. Preview the Website Locally

Run the development server:

npm run start

Then open http://localhost:3000/ in your browser.

The page will update automatically when you edit files.

📸 Example local preview:

---

3. Making Changes to the Documentation

Most edits are just Markdown files inside the docs/ folder.

📂 Folder Structure

open-hand-doc/
├── docs/            ← main documentation files
│   ├── intro.md
│   ├── usage.md
│   └── my-new-page.md
├── docusaurus.config.js
├── package.json
└── README.md

Steps to Add or Edit Docs

1. Open the docs/ folder
2. Duplicate an existing file or edit one
3. Save changes

Markdown Basics (for Non-Coders)

Markdown	Result
# Title	Large title
## Subtitle	Section heading
- item	Bullet list
[text](https://example.com)	Link
	Image

📸 Editing example:

---

4. Submitting Changes (Pull Requests)

Create a New Branch

git checkout -b user/yourname/my-change

Save & Commit

git add .
git commit -m "Added new documentation page"
git push origin user/yourname/my-change

Open Pull Request

1. Go to GitHub
2. Click "Compare & pull request"

📸 GitHub PR button:

🔒 Note: One reviewer must approve before merge.

---

5. Validating with Netlify Preview

When you create a PR, Netlify builds a preview site.

📸 Example (your screenshot):

✅ Shows "Deploy Preview ready"

🔗 Link to preview site (e.g., https://deploy-preview-2--openhandlite.netlify.app)

🔍 Link to deploy logs

👉 Click the preview link to check your changes before merging.

---

6. Deployment

After PR is approved and merged to main:

• Netlify deploys automatically
• Visit https://docs.tetheria.ai to see updates
• Usually takes 1–2 minutes

📸 Deployed site example:

---

8. Advanced Configuration

For more advanced changes to the website configuration, styling, and functionality, see our Advanced Changes Guide.

This guide covers:

• 🔧 Project structure and file organization
• 📋 Sidebar navigation customization
• 🎨 Website branding (title, logo, links)
• 🖼️ Image management and optimization
• 🎭 Theme and styling modifications
• 🔌 Plugin configuration and extensions
• ✅ Best practices for development workflow

---

Summary Workflow

Visual Workflow

Clone repo → npm install
     ↓
Preview site → npm run start
     ↓
Edit docs/*.md
     ↓
Push & open PR → get approval
     ↓
Check Netlify preview → confirm
     ↓
Merge → site updates live

---