Skip to content

e35ventura/taopedia

Repository files navigation

Taopedia

Taopedia is a Bittensor-focused knowledge base for TAO, subnets, wallets, staking, mining, validation, consensus, and protocol operations.

This repository contains the website application. Article content lives in the companion content repository:

https://github.com/e35ventura/taopedia-articles

Live site:

https://taopedia.org

Social Media

X: @venturalabs

Repository Role

  • Website UI, routing, search, layouts, and build scripts live here.
  • Articles are authored in taopedia-articles as MDX.
  • During local development and production builds, this app syncs approved Bittensor articles into src/content/pages.
  • Generated article output is ignored by Git in this repo.

If you want to add or edit an article, open a PR in taopedia-articles. If you want to improve the site experience, open a PR here.

What To Work On Here

Good changes for this repo include:

  • UI and UX improvements.
  • Search, navigation, and article-reading improvements.
  • Accessibility and responsive layout fixes.
  • Build, deployment, and security hardening.
  • Bugs in article rendering, category pages, backlinks, or generated metadata.

Do not add normal article content here. Put article changes in taopedia-articles.

Development

Clone both repositories next to each other:

git clone https://github.com/e35ventura/taopedia.git
git clone https://github.com/e35ventura/taopedia-articles.git
cd taopedia
npm install
npm run dev

Expected local layout:

parent-folder/
  taopedia/
  taopedia-articles/

If the articles repo is somewhere else, set TAOPEDIA_ARTICLES_DIR:

TAOPEDIA_ARTICLES_DIR=/path/to/taopedia-articles npm run dev

Open:

http://localhost:4321

Build

npm run build
npm run preview

The build:

  1. Syncs Bittensor-scoped MDX articles from taopedia-articles.
  2. Generates article history data.
  3. Builds link graph and category data.
  4. Builds the static Astro site into dist.
  5. Builds the Pagefind search index.

Articles publish when:

  • the slug is taopedia;
  • or tags includes Bittensor.

Categories are flexible topics. Bittensor is a scope tag, not a required category.

Branches And Releases

  • Contributor PRs target test.
  • Maintainers promote test to main after review.
  • Production deploys from main.
  • Article-only changes are reviewed in taopedia-articles and appear after the next site rebuild.

Project Structure

taopedia/
  src/
    content/
      pages/              generated by scripts/sync-articles.js
    layouts/
    pages/
    styles/
  scripts/
    sync-articles.js
    generate-history.js
    build-linkgraph.js
  public/
  netlify.toml
  package.json

Contributing

Read CONTRIBUTING.md before opening a PR.

About

Bittensor-focused knowledge base website for Taopedia

Topics

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors