docs: reposition around agents + OKF + freshness, strip em dashes#152
Merged
Conversation
Lead the README and docs landing with the agents-first story: OKF makes docs
portable and accessible, Surface governs their freshness, and together they
measurably improve how well agents perform. Promote the OKF section to a
co-equal pillar (up near "how it works"), reframe "why it matters" as the
positive, benchmark-backed payoff, and drop the remaining accusatory framing
("stale docs make agents fail", "completely false documentation").
Also replace em dashes with hyphens across the published docs, readme, and
hubs (excludes CHANGELOG, dogfood-log, STRATEGY, surface-proposal as
historical/internal records). Prose-only: surf check stays green, no anchor
hashes touched.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only pass. Sharpens Surface's positioning around the agents-first story and strips em dashes across the published docs. No code changes;
surf checkstays green.Changes Made
README.md,docs/index.md): lead with "portable, always-fresh docs for agents and humans" - OKF (Google's open format) makes docs portable and accessible, Surface governs their freshness, and together they measurably improve how well agents perform.docs/**, andhubs/**(303 replacements). Excludes CHANGELOG,docs/dogfood-log.md, STRATEGY, anddocs/surface-proposal.mdas historical/internal records.Type
Documentation
Testing
surf checkgreen (prose-only edits; no anchor hashes touched)surf lint0 errors (only pre-existing coverage warnings)🤖 Generated with Claude Code