Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
64 changes: 64 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,67 @@ node_modules
# IDE
.vscode
*.code-workspace

# V2
# ------------------------------------
# Node
# ------------------------------------
# node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
package-lock.json
yarn.lock
pnpm-lock.yaml

# Optional: ignore local `.env` files
.env
.env.*local

# ------------------------------------
# Logs
# ------------------------------------
logs/
*.log
*.log.*
debug.log

# ------------------------------------
# OS / Editor files
# ------------------------------------
# .DS_Store
Thumbs.db
.idea/

# VSCode — allow settings.json, ignore rest
# .vscode/*
# !.vscode/settings.json
# !.vscode/extensions.json

# ------------------------------------
# Mintlify / Build Stuff
# ------------------------------------
.mintlify/
.mintlify-cache/
.out/
dist/
build/

# ------------------------------------
# Temporary files
# ------------------------------------
*.tmp
*.temp
*.swp
*.swo

# ------------------------------------
# TypeScript
# ------------------------------------
*.tsbuildinfo

# ------------------------------------
# External docs (fetched at build time)
# ------------------------------------
snippets/external/
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ npm i -g mintlify
Run the following command at the root of your documentation (where mint.json is)

```bash
mintlify dev
mint dev
```
45 changes: 45 additions & 0 deletions README_V2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
V2 Docs are being ported in to this repo.

I will work on a branch called docs-v2 and then merge into main when fully ready
and deprecate the old docs into a v1 on the new docs.

TODO:

- Remove/Change Navbar in V2 (Global Setting)
- Add redirects (Global Setting)
- Add Analytics (Global Setting)
- Add Footer (Global Setting)
- Add SEO (Global Setting)
- Add Custom Domain (Global Setting)
- Add Custom 404 (Global Setting)?

Notes from stakeholders/feedback

- “The gateways section should definitely include… technical documentation on
how to run and operate a gateway node because that’s missing.”
-

Notes on layout

- Consider moving resource and help anchors to right tabs on menu (styling).
Would prefer navbar buttons - but external links only there :/

- Consider having an Index & FAQ/Glossary page in each tab - Possibly use AI to
make it per page (llm intiially then n8n integration keeps it updated)

About:

- Protocol: Called Protocol Actors or Network Participants? Both?
- I am not convinced about the side bar sections.

Removing: "v2/pages/01_about/livepeer-protocol/livepeer-actors/gateways",
"v2/pages/01_about/livepeer-protocol/livepeer-actors/orchestrators",
"v2/pages/01_about/livepeer-protocol/livepeer-actors/delegators",
"v2/pages/01_about/livepeer-protocol/livepeer-actors/end-users"

Community

- move HUBS to appropriate tabs
- Hate the naming of all connect items.

Developer
Loading
Loading