docs: resync the site with the code it describes - #245
Merged
Conversation
Three passes of doc-vs-source comparison found drift that all landed the same way: a feature merged, and the index pages that route readers to it did not. - CLI pages counted nineteen commands after `dictionary` made twenty - Five pages (versioned, text-processing, preset-engine, and both performance reports) were reachable only by URL, listed in no section index - commands.md had its V3 section appended below the nav footer, so the footer rendered mid-page - CacheStats and ParallelOptions type listings omitted three fields the same page describes in prose lower down CONTRIBUTING.md gains the four Make targets it never documented (bench, bench-module, bench-v3, proto) and a corrected doccheck fence count, and Getting Started now links the three runnable examples/ programs, which build against the current API but were mentioned nowhere.
This was referenced Sep 6, 2026
Merged
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.
Pull Request
Description
Three passes of doc-vs-source comparison, one per
/update-docsrun. Everything found had drifted the same way: a feature merged, and the index pages that route readers to it did not follow.Reachability. Five pages existed with no inbound link from their section index —
reference/versioned,reference/text-processing,guides/preset-engine, and both performance reports. Hugo published them; nothing pointed at them.guides/_index.mdhad not been touched in 139 days, which is howpreset-enginewent unlisted.Counts.
dictionary(#244) made the CLI twenty commands. Three places still said nineteen —cli/_index.mdtwice,_index.md's CLI card once — and the command table had no row for it.Structure.
cli/commands.mdhad its "Versioned dictionaries" section appended below## Navigation, so the nav footer rendered mid-page.Type listings. The
CacheStatsandParallelOptionsblocks inreference/api.mdomittedPresetReloadFailures,PresetPollFailures, andAutoOverlap. All three are described in prose further down the same page — the listing that claims to show the type's shape just did not show them. Also correctedChunkSizeandOverlap, which the block labelled as having defaults when a hand-builtParallelOptionshas none (ChunkSizefails withErrInvalidChunkSize;Overlapmeans zero).CONTRIBUTING.md. Documented the four Make targets it never covered —
bench,bench-module,bench-v3,proto— including thatbench-moduleneedsACOR_INTEGRATION_ADDRand thatprotois the one target needing a toolchaingowill not install. Its doccheck fence count said 22 of 91; it is now 25 of 93.Examples.
examples/basic,examples/batch, andexamples/parallelbuild against the current API but were mentioned in no doc page. Linked from Getting Started with thego runline and thelocalhost:6379prerequisite.Checked and found already in sync, so left alone: the 8 proto RPCs against
server/grpc-api.md, the 9 HTTP routes againstserver/http-api.md, the 6acor_*metric names againstoperations/monitoring.md, and all four server constructors againstserver/running.md.Type of Change
Checklist
make test) — no Go files changed; pre-commit skipped the Go hooks for that reasonmake vet— samemake lint) — samemake build) — samemake docs-verifypasses, 25 blocks compiledchangie new) —changes/unreleased/20260906-docs-index-resync.yaml, kindDocumentationAdditional Notes
No prose was rewritten and no page was created. Every change is a link, a count, a field, a section move, or a Make target — the parts of these files that are derivable from source and had stopped matching it.
make docs-verifyis the only gate that covers this content, and it only compiles Go fences carrying a<!-- doccheck -->marker. None of the drift here was in a marked fence, which is why all of it survived CI.By submitting this PR, I agree that my contributions will be licensed under the Apache License 2.0.