Repository navigation
Pare the README down to an overview and move the rest to docs - #54
Merged
Merged
Conversation
The README was a short overview followed by the older long README. Keep the overview (pitch, support, quick start, why it is fast) plus a binary table and the documentation index, and move what only the README carried: - usage examples and the compare/validate, checkpoint and partition notes to docs/usage.md - the build-spec reference and its differential test to docs/build-spec.md - the FlashArray SMB-written data guidance to a new spec-guide subsection - the FlashArray SACL throughput figure to docs/performance.md Problem, How it works, backends, deployment, the spec format and testing were already covered by DESIGN, INSTALL, spec-guide and CONTRIBUTING. Sync docs/spec-guide.html: the new SMB-written data subsection, and the --sacl section, which still said a DACL reset keeps audit ACEs without the ErrAuditedObject refusal and --allow-audited-dacl-reset. TestDocumentedCaptureCommandsRun now reads the build-spec commands from docs/build-spec.md, and links into the old README sections are repointed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The old README paired the READDIR+SETATTR fold's 200K ops/sec (S500, Purity//FB 4.8.0, from the CHANGELOG) with the S500R1 kernel baseline of 118,080 to claim 1.70x. Those are different arrays. docs/performance.md gives the measured S500R1 comparison (1.50x), which predates the fold. Say so, record the fold's own measurement and its source, and note that the S500R1 comparison has not been rerun with the fold. Co-Authored-By: Claude Opus 5.5 <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
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
The README was a short overview followed by the older long README (the seam was at
## Problem). This keeps the overview and points readers to the right document for everything else. README: 363 → 93 lines.Kept: pitch, support statement, quick start, why it is fast, a binary table, and the documentation index.
Moved (only the README had it):
docs/usage.mddocs/build-spec.md--accept-dacl-flattening,Get-Aclcaveats)### SMB-written dataindocs/spec-guide.md/.htmldocs/performance.mdDropped as duplicates: Problem, How it works, protocol backends and multiprotocol (DESIGN.md), Deployment (INSTALL.md), the spec format and SACL section (spec-guide), Testing (CONTRIBUTING.md).
Also:
docs/spec-guide.htmlwas behind the.mdin its--saclsection: it still said a DACL reset keeps audit ACEs, with no mention of theErrAuditedObjectrefusal,--allow-audited-dacl-reset, or inherited access changing on refused objects. Synced that section along with the new subsection. The rest of the HTML was not diffed against the.md.TestDocumentedCaptureCommandsRunnow requires 3 build-spec commands indocs/build-spec.md(and 1 in README.md) instead of 3 in README.md.docs/limitations.md).docs/CLAUDE.mdlists the new docs.Performance figure: the old README gave userspace 200K ops/s (1.70× kernel). The 200K is the READDIR+SETATTR fold measurement (CHANGELOG, S500, Purity//FB 4.8.0) and the 118K kernel baseline is from an S500R1, so the ratio compared two different arrays.
docs/performance.mdkeeps the measured S500R1 comparison (1.50×) and now says that it predates the fold, records the fold's own figures and where they come from, and notes that S500R1 has not been rerun with the fold.Checks
go test ./...passes;tools/public-scan/scan.shand--commits main..HEADclean.🤖 Generated with Claude Code