Skip to content
Merged
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
  •  
  •  
  •  
7 changes: 6 additions & 1 deletion .lycheeignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
http://localhost*
https://localhost*
https://localhost*
# Testnet explorer returns 401 but links are valid
https://testnet-explorer.tangle.tools/*
# Internal MDX routes without .mdx extension (valid Nextra routes, not filesystem paths)
.*/claim-airdrop$
.*/join_operator/join$
68 changes: 68 additions & 0 deletions CONTENT_AUDIT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Documentation Audit (v2 Migration)

Last updated: 2026-01-19

## High-Priority Fixes

| Area | File | Status | Notes / Needed Inputs |
| ---- | ---- | ------ | --------------------- |
| Network parameters | `pages/network/network-parameters.mdx` | Updated (testnet + sources) | Mainnet/local addresses still needed. |
| Token allocation | `pages/network/tokenomics/allocation.mdx` | Updated (tnt-core values) | Need distribution contract addresses by environment. |
| Inflation model | `pages/network/tokenomics/inflation.mdx` | Updated | Reflects v2 budgeted incentives; verify against current policy. |
| Operator incentives | `pages/network/incentives-operators.mdx` | Updated | Confirm default fee split and operator commission rules. |
| Developer incentives | `pages/network/incentives-developers.mdx` | Updated | Confirm metric weights and eligibility rules. |
| Participation credits | `pages/network/points-mechanics.mdx` | Updated (testnet) | Mainnet/local addresses still needed. |
| Launch page | `pages/network/launch.mdx` | Needs investigation | Reported runtime error; content updated with v2 links. |
| Governance docs | `pages/network/governance.mdx` | Removed | Replace with new governance system when ready. |
| Differences doc | `pages/network/overview.mdx` | Updated | Content merged; old doc removed. |
| Use cases | `pages/vision/use-cases.mdx` | Updated | Review for AI alignment and add any missing product references. |

## Follow-Up Candidates

| Area | File | Status | Notes |
| ---- | ---- | ------ | ----- |
| Token usage + gas model | `pages/network/tokenomics/usage.mdx` | Updated | TNT is not the gas token; usage text cleaned up. |

## Operator Section Cleanup (v2)

| Task | Files | Status | Notes |
| ---- | ----- | ------ | ----- |
| Remove v1 node docs | `pages/operators/node-basics/*` | Done | Deleted (dirs removed). |
| Remove node monitoring docs | `pages/operators/monitoring/*` | Done | Deleted (dirs removed). |
| Remove operator onboarding page | `pages/operators/onboarding.mdx` | Done | Deleted. |
| Remove operator Tangle AVS docs | `pages/operators/tangle-avs/*` | Done | Deleted (dirs removed). |
| Update operator entry points | `pages/operators/_meta.ts`, `components/OperatorIntro.tsx` | Done | Now points to Blueprint Manager + operator registration. |
| Align operator docs to Blueprint Manager | `pages/operators/benchmarking.mdx`, `pages/operators/operator/join_operator/*` | Done | Updated to CLI + pricing-engine workflow. |
| Audit Blueprint Manager setup details | `pages/operators/manager/*` | Pending | Verify RPC/WSS endpoints, chain IDs, and runtime commands are v2. |
| Review remaining operator pages | `pages/operators/quality-of-service.mdx`, `pages/operators/pricing/overview.mdx` | Pending | Ensure no stale commands or v1 references. |

## Economic Security Cleanup (Stake)

| Task | Files | Status | Notes |
| ---- | ----- | ------ | ----- |
| Remove liquid staking docs | `pages/staking/lrt-*`, `pages/staking/lrt_developers/*` | Done | Deleted. |
| Remove liquid staking docs | `pages/staking/lst-*`, `pages/staking/join_a_pool/*`, `pages/staking/create_a_pool/*`, `pages/staking/lst_developers/*` | Done | Deleted. |
| Remove PolkadotJS stake docs | `pages/staking/how_to_stake/how_to_stake_polkadotjs/*`, `pages/staking/credits/claiming.mdx`, `pages/staking/nominator.mdx` | Done | Deleted. |
| Remove outdated diagrams | `public/images/liquid-staking/*`, `public/images/staking/how-to-stake-polkadotjs/*`, `public/images/staking-workflow.png` | Done | Deleted. |
| Update stake intro + concepts | `pages/staking/introduction.mdx`, `pages/staking/how-staking-works.mdx`, `pages/staking/staking-concepts.mdx` | Done | Updated for v2 staking. |
| Add liquid staking placeholder | `pages/staking/liquid-staking.mdx`, `pages/staking/_meta.ts` | Removed | Placeholder removed and replaced by v2 liquid staking docs. |
| Add liquid staking docs (v2) | `pages/staking/liquid-staking/*` | Done | Based on LiquidDelegationVault + LiquidDelegationFactory. |

## Blueprint + SDK Alignment (v2)

| Task | Files | Status | Notes |
| ---- | ----- | ------ | ----- |
| Update local testing guide to Anvil harness | `pages/developers/testing-with-tangle.mdx` | Done | Uses Blueprint SDK harness + tnt-core fixtures. |
| Update blueprint introduction for v2 terminology + payments | `pages/developers/blueprints/introduction.mdx` | Done | Aligns with tnt-core payment flow and service terminology. |

## Legacy Substrate References (Needs Review)

| Area | File | Status | Notes |
| ---- | ---- | ------ | ----- |
| Blueprint Manager doc | `pages/developers/blueprints/manager.mdx` | Done | Updated to tnt-core contract terminology. |
| Blueprint pricing engine | `pages/developers/blueprints/pricing-engine.mdx` | Done | Rewritten to match blueprint-sdk pricing engine. |
| Address formats | `pages/developers/technicals/addresses.mdx` | Done | Deleted. |
| Transaction fees | `pages/developers/technicals/transaction-fees.mdx` | Done | Deleted. |
| Precompile docs | `pages/developers/precompiles/*` | Done | Deleted. |
| Slashing flow | `pages/network/slashing.mdx` | Done | Deleted. |
| Hardhat deployment guide | `pages/developers/technicals/deploy-using-hardhat.mdx` | Done | Deleted. |
38 changes: 38 additions & 0 deletions PROJECT_CHECKLIST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Tangle Docs Cohesion + IA Checklist

Last updated: 2026-01-19

Status legend: [ ] Not started, [~] In progress, [x] Done

## Navigation + IA
- [x] Top nav limited to Vision, Workbench, Runtime, Protocol.
- [x] Protocol dropdown includes Protocol Foundation, Build, Operate, Economic Security.
- [x] Sidebar shows only children for the active section and hides the section label.
- [x] Remove AI top-level tab and split into Workbench + Runtime.

## Content Cohesion
- [x] Apply canonical framing across Overview pages.
- [x] Replace "Vibe" with "workbench" across docs.
- [x] Add explicit "Today vs Future" callout in Overview and Protocol.
- [x] Add trust/execution safety narrative (policies, audit logs, approvals, evaluation loop).
- [x] Add role-based "Start here" blocks for each persona.
- [x] Add minimal glossary and enforce term consistency.
- [x] Replace "staking" terminology with "staking" in human-facing docs.
- [x] Add liquid staking docs aligned with v2 contracts.

## Accuracy (Against Internal Codebases)
- [x] Audit workbench codebase and summarize key capabilities.
- [x] Audit runtime orchestration codebase and summarize key capabilities.
- [x] Align runtime docs with orchestration + sidecar responsibilities.
- [x] Surface autoscaling/observability capabilities in operator docs.
- [x] Align QoS observability + keystore guidance with blueprint-sdk behavior.

## Visuals
- [x] Use autonomous-work-loop diagram as primary system visual.
- [x] Remove SaaS-to-marketplace diagram.
- [x] Add captions and labels where the system diagram appears.

## Cleanup + QA
- [x] Scan for outdated validator references and remove.
- [x] Verify no closed-source repo names appear in published docs.
- [x] Run terminology scan for "Vibe" and replace.
62 changes: 62 additions & 0 deletions PROJECT_SPEC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Tangle Docs Cohesion + IA Spec

Last updated: 2026-01-19

## Problem Statement
The docs feel fragmented across product, runtime, and protocol. Roles blur, the story mixes present and future, and navigation makes it hard to understand where to start. The result is weak cohesion and low trust for new readers.

## Goals
- Present a single, consistent mission and system model across all sections.
- Make roles and journeys obvious: workbench user, runtime operator, protocol builder, partner/investor.
- Separate "what exists today" from "what evolves over time."
- Keep top navigation minimal while ensuring section sidebars are deep and focused.
- Emphasize AI-native value (autonomous work) without over-indexing on staking.
- Ensure trust: sandbox safety, auditability, approvals, and evaluation loops are explicit.

## Non-Goals
- Full product roadmap, pricing, or competitive positioning beyond brief comparisons.
- Detailed protocol economics documentation (kept in protocol docs only).
- Marketing site rewrite (this spec is for docs).

## Canonical Framing (Use Everywhere)
Tangle is the shared operating layer for autonomous work. Teams and agents collaborate in shared workbenches or separate ones, work runs in secure sandboxes, and the protocol pays the operators who host the runtime. Workflows improve through agent and task evaluations collected from each run.

## System Model
- **Workbench (Experience Layer)**: Multiplayer workspaces where humans and agents collaborate.
- **Sandbox Runtime (Execution Layer)**: Secure, isolated sandboxes that execute tasks with policies and limits.
- **Protocol (Coordination Layer)**: Operator coordination, payment routing, and economic security.
- **Evaluation Loop**: Each run produces task and agent evaluations that improve workflows over time.

## Information Architecture
Top nav (minimal):
- Vision
- Workbench
- Runtime
- Protocol (dropdown: Protocol Foundation, Build, Operate, Economic Security)

Sidebar behavior:
- Show only the active section's children.
- Do not show the section label in the sidebar.

Section mapping:
- Vision: mission, use cases, architecture, core concepts, glossary.
- Workbench: intro, workflows, simulations, profiles, integrations.
- Runtime: intro, orchestration, security model, observability, scaling.
- Protocol: foundation, build, operate, economic security (staking + liquid staking).

## Content Guidelines
- Avoid naming closed-source repositories or internal codebases.
- Use "workbench" and "sandbox runtime" consistently; avoid "Vibe".
- Keep EigenLayer mentions out of primary navigation and framing.
- Always state what is live today vs what is planned.
- ELI5 clarity on "who does what" for each page.

## Diagram Standards
- Primary system diagram: autonomous work loop (workbench -> sandbox -> protocol -> evaluation).
- Use one diagram consistently across hero + architecture pages.
- Diagrams must label the three layers clearly and show the evaluation loop.

## Open Questions
- What is the smallest viable glossary for launch?
- Which operator trust signals should be surfaced early (logs, receipts, approvals)?
- Where should "today vs future" live: Overview or Protocol?
127 changes: 0 additions & 127 deletions components/CommonActions.tsx

This file was deleted.

Loading