Release 0.2.0: docs foundation, AGENTS.md enforcement (#14), surf suggest (#18)#25
Merged
Conversation
Establish a place for documentation to grow before it bloats the README, plus a changelog and an agent on-ramp. Foundation only — portable generator-agnostic markdown, no site tooling, README left intact. - CHANGELOG.md: Keep a Changelog + SemVer; [Unreleased] captures the merged check-scoping / JSON / lint-granularity work; 0.1.1 and 0.1.0 reconstructed from git history. - docs/index.md: documentation map mirroring the future site nav; links README reference sections rather than duplicating them (single source of truth). - docs/guides/authoring-hubs.md, docs/guides/ci-integration.md, docs/examples.md: new gap-filling content (not in the README). - AGENTS.md: agent on-ramp — points at hubs/ as governed context and documents the dogfooding loop (lint → check → verify, keep prose honest, update changelog). - README.md / CONTRIBUTING.md: minimal pointers to the above. surface-proposal.md and phases/ unchanged (relabeled as internal in the index). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Scan filenames and the summary: line, then open the relevant hub(s) — reading the whole directory is wasteful context. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…e 0.2.0 Closes #14, closes #18. Cuts the 0.2.0 minor release for the merged check-scoping / JSON / lint-granularity features plus these two. #14: surf lint validates the AGENTS.md `<!-- surf:hubs -->` block — it must link the configured hubs directory (which must exist), blocking otherwise. Opt-in (silent without the markers). Points agents at the directory to search; never enumerates individual hubs, which would push an agent to read everything. #18: `surf suggest <globs>` scans source for top-level public functions no hub anchors yet and prints a copy-pasteable starter hub. Read-only — never writes a file or stamps a hash. Reuses surf_core::public_fns and the lint coverage notion. 0.2.0: version bump + Cargo.lock; CHANGELOG [Unreleased] -> [0.2.0] with a Changed note that an explicit --base now diff-scopes; pinned versions in install snippets bumped to v0.2.0; docs + dogfood hubs (cli-suggest, cli-lint) updated and re-verified. 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.
Cuts 0.2.0 — a minor bump for the backward-compatible features merged since 0.1.1, plus two more issues and the documentation foundation.
Features
surf lintvalidates the<!-- surf:hubs -->block inAGENTS.md: it must link the configured hubs directory (which must exist), blocking otherwise. Opt-in (silent without the markers). Points agents at the directory to search — never enumerates individual hubs, which would push an agent to read everything. Closes AGENTS.md lint-enforced pointer block #14.surf suggest <globs>. Scans source for top-level public functions no hub anchors yet and prints a copy-pasteable starter hub. Read-only — never writes a file or stamps a hash. Reusessurf_core::public_fnsand the lint coverage notion. Closes surf suggest: propose anchors from public symbols (lower authoring cost) #18.Docs foundation
docs/tree (index + authoring-hubs / ci-integration guides + examples),CHANGELOG.md, andAGENTS.md. Generator-agnostic markdown; README left intact aside from link/version updates.Release 0.2.0
Cargo.lock; CHANGELOG[Unreleased]→[0.2.0]with a Changed note that an explicit--basenow diff-scopes; install-snippet pins bumped tov0.2.0.Verification
cargo fmt --check,clippy -D warnings, full test suite (63 tests, 7 new) all pass. Dogfooded:surf lintexits 0,surf checkgreen after re-verifying the affected hubs.🤖 Generated with Claude Code