Skip to content

docs(whitepaper): sharpen protocol voice#181

Merged
drewstone merged 1 commit into
mainfrom
docs/whitepaper-voice-pass
Jun 14, 2026
Merged

docs(whitepaper): sharpen protocol voice#181
drewstone merged 1 commit into
mainfrom
docs/whitepaper-voice-pass

Conversation

@drewstone

Copy link
Copy Markdown
Contributor

Summary

  • rewrites the strongest AI-sounding sections in the Protocol, Cloud, and Blueprint SDK whitepapers
  • replaces vague platform/ecosystem language with concrete protocol, operator, service-instance, and market mechanics
  • regenerates the three tracked PDFs from the updated TeX sources

Validation

  • rg -n "\b(seamless|robust|powerful|cutting-edge|groundbreaking|game-changing|revolutionary|innovative|next-generation|world-class|best-in-class|state-of-the-art|delve|tapestry|landscape|paradigm|synergy|holistic|pivotal|crucial|ecosystem|platform)\b|At its core|Let's dive|not just|more than just|showcase|underscores|key role|serves as|stands as|testament|Additionally|Moreover|In order to|It is important to note|—" whitepaper/*.tex only matches the literal environment-variable phrase uppercase with underscores\n- git diff --check -- whitepaper\n- pdflatex -interaction=nonstopmode -halt-on-error tangle-protocol.tex until references settled\n- pdflatex -interaction=nonstopmode -halt-on-error tangle-cloud.tex until references settled\n- pdflatex -interaction=nonstopmode -halt-on-error tangle-sdk.tex until references settled\n- log check found no unresolved references or rerun-required warnings\n- git merge-tree --write-tree origin/main HEAD

@tangletools tangletools left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Auto-approved PR — bab422d8

Blanket team auto-approval is enabled for this reviewer service.
The full PR reviewer audit still runs separately and will publish findings if it detects issues.

tangletools · auto-approval · reason: blanket_auto_approve · 2026-06-14T22:45:43Z

@tangletools tangletools left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Value Audit — sound

Verdict sound
Concerns 0 (none)
Heuristic 0.0s
Duplication 0.0s
Interrogation 98.9s (2 bridge agents)
Total 98.9s

💰 Value — sound

Rewrites the three whitepaper TeX sources to strip AI/marketing fluff and replace vague ecosystem/platform language with concrete protocol mechanics, then regenerates the tracked PDFs — a coherent docs-only improvement that ships.

  • What it does: Edits whitepaper/tangle-cloud.tex, whitepaper/tangle-protocol.tex, and whitepaper/tangle-sdk.tex to remove buzzwords (seamless, robust, cutting-edge, ecosystem, platform, etc.) and generic AI phrasing (At its core, Moreover, not just…), replacing them with specific terms like operator, service instance, RFQ, market, network operations, and protocol roles. It then regenerates the three matching PDF
  • Goals it achieves: Sharpen the whitepapers' voice so they read as technical protocol documentation rather than generative-AI marketing copy, and align the language with the actual on-chain mechanics (blueprints, operator staking, service instances, fee splits, RFQ, slashing).
  • Assessment: Good change on its merits. The rewrites preserve technical accuracy and often improve precision (e.g., distinguishing a blueprint from a service instance, replacing 'ecosystem growth' with 'network operations', describing O(1) accounting as a design requirement). The PR validation grep confirms the banned terms are gone except for the intentional 'uppercase with underscores' phrase, git diff --che
  • Better / existing approach: none — this is the right approach. I checked .github/workflows/, the whitepaper/ directory, and git log for prior churn on these files. There is no existing whitepaper linting/style gate, no reusable TeX/PDF build script, and no other docs that reference these PDFs. Regenerating the tracked PDFs from the edited .tex files follows the repo's established workflow (see prior commits a8b5bfd and 0341d

🎯 Usefulness — sound

A documentation-only voice polish that regenerates the three tracked whitepaper PDFs from updated TeX sources; it fits the existing whitepaper maintenance pattern and introduces no unreachable or competing surface.

  • Integration: The changed files are static documentation artifacts (whitepaper/*.tex and *.pdf). They are not wired into CI, build scripts, or runtime code, and are not linked from README.md or docs/. Grep found references to "whitepaper" only in whitepaper/.gitignore:1 and .soldeerignore:36. However, this is the pre-existing state; the PR does not introduce a new integration gap. Whitepapers serve an external
  • Fit with existing patterns: The change fits the established repository pattern: prior commits a8b5bfd and 0341d40 also updated the same TeX sources and regenerated PDFs. The .soldeerignore already excludes the whitepaper directory from package distribution, consistent with treating these as standalone documents rather than code artifacts. No competing documentation pattern exists.
  • Real-world viability: This is a text-level documentation change with no runtime behavior, concurrency, or error paths to evaluate. I verified the TeX compiles successfully with pdflatex (exit 0), the PR's banned-word regex matches only the claimed exception at tangle-sdk.tex:1294, and git diff --check passes. The regenerated PDFs are binary artifacts committed alongside sources, following the repo's existing practice.

No concerns — sound change, no better or existing approach found. ✅


What this audit checks

It judges the change on its merits — not whether it was tasked out in an issue. Unticketed, fast-moving work is fine; the question is whether the change is good and whether a better or existing approach should be used instead.

Pass What it asks
Heuristic Vague title? Whitespace-only or cruft-bearing diff? (content signals only)
Duplication Do added function/class names already exist elsewhere in the repo?
Value Audit What does it do? What goal does it achieve? Is it good? Better architecture or already-exists?
Usefulness Audit Does it integrate and fit? Will it hold up in real use and actually get used?

Findings are concerns, not blocks — the human reviewer decides what to do with them.

value-audit · 20260614T224916Z

@tangletools

Copy link
Copy Markdown
Contributor

✅ No Blockers — bab422d8

Readiness 89/100 · Confidence 90/100 · 3 findings (3 low)

deepseek glm aggregate
Readiness 92 89 89
Confidence 90 90 90
Correctness 92 89 89
Security 92 89 89
Testing 92 89 89
Architecture 92 89 89

Full multi-shot audit completed 6/6 planned shots over 6 changed files. Global verifier still owns final merge decision. | Full multi-shot audit completed 6/6 planned shots over 6 changed files. Global verifier still owns final merge decision.

🟡 LOW Value-recipient list omits protocol in vision paragraph — whitepaper/tangle-cloud.tex

Line 59: 'Economic value flows to the operators, developers, delegators, and keepers doing the work.' lists 4 recipients but omits the protocol (19.5% per Table 1, line 86). Line 465 correctly lists all 5. This is a minor prose inconsistency in a vision statement, not a factual protocol error — the protocol does not 'do work' in the colloquial sense. Fix: add 'and the protocol' or leave as-is if the omission is intentional

🟡 LOW Pre-existing discrepancy: whitepaper developer share (10%) vs contract default (25%) — whitepaper/tangle-protocol.pdf

The PDF's distribution table (Section 7.3) lists Developers (merit) at 10%, but InflationPool.sol:296-297 sets developersBps: 2500 (25%). The PR's reworded prose ('allocates 10% of treasury-funded emission to blueprint developers') preserves this 10% figure from the prior version, so the PR does not introduce the error. However, the discrepancy is visible in the changed file and could mislead readers cross-referencing the contract. Fix: either update the whitepaper table and prose to 25% to match the contract default, or confirm the whitepaper reflects a governance-adjusted target distinct from the genesis default and annotate accordingly.

🟡 LOW Subjective: 'final pricing at service creation' replaces 'instant finality' — whitepaper/tangle-protocol.tex

Line 328 (diff): 'RFQ fits heterogeneous operators, requires no standing on-chain order book, and gives final pricing at service creation.' Original: 'provides instant finality.' The RFQ flow (lines 330-341) describes quotes having expiry/replay protection and submission in a single transaction, which supports both phrasings. 'Final pricing' is slightly narrower (addresses only price, not overall service finality). Low severity — the RFQ flow text fully disambiguates this.


tangletools · 2026-06-14T22:54:25Z · trace

@drewstone drewstone merged commit 9652412 into main Jun 14, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants