Skip to content

Tenyokj/bert-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

BERT Docs (Standalone)

This directory is a standalone docs site for BERT protocol. It is intentionally isolated so you can move it into a separate repository later (bert-docs).

Run locally

cd bert-docs
python3 -m http.server 4040

Open: http://localhost:4040

Structure

  • index.html - docs app shell
  • assets/styles.css - minimal docs styling
  • assets/docs-data.js - documentation pages and content
  • assets/app.js - sidebar routing + full-text search

How search works

Search checks:

  • page title
  • page summary
  • full page text content

It supports topic search (e.g. subgraph, voting) and plain text search (e.g. setVotingDuration, sepolia eth).

Move to separate repo later

cd ..
cp -R bert-docs /path/to/new/location/bert-docs
cd /path/to/new/location/bert-docs
git init
git add .
git commit -m "init bert docs"

Planned next improvements

  • Split docs-data.js into per-page markdown files and add build step.
  • Add version switcher (v1, v2).
  • Add command-copy buttons for code blocks.
  • Add print-friendly mode for audits and compliance reviews.

About

Full documentation for BERT project!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published