Repository navigation
docs: prune unearned comments and stale cross-references - #28
Merged
hmziqrs merged 1 commit intoOct 31, 2026
Merged
Conversation
Comment-discipline audit cleanup across the repo: - tests/edge_cases.rs: drop mod doc with change narration, section banners, and inline play-by-play (intent lives in test names) - main crate: trim eleven over-length docs on non-public items to the 3-line cap - satellites: reclassify private-item /// docs as // constraint notes - web: delete dead techArticle/howTo schema helpers guarded by a false claim, six comments pointing at removed files, React-port narration headers, and pure section banners; compress starlight.css boxes to their invariants - skills: make the extensions bootstrap example actually call hydrate instead of documenting a step it never performed
hmziqrs
approved these changes
Oct 31, 2026
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.
Comment-discipline audit cleanup across the repo (30 files, +103/−288). No behavior changes except deleting two dead functions.
Rust crates
tests/edge_cases.rs: drop the 16-line mod doc (contained change narration), seven section-banner blocks, and inline play-by-play; intent already lives in the test namesclient/persist.rs,bucket/shared.rs,mutation_bucket.rs,hook/fetch_retry.rs,mutation_hooks/internals.rs,use_infinite_query/fetch_runners.rs,core/error/sanitize.rs)///docs as//constraint notes (gpui-query-persist6,gpui-query-http2)Web
src/lib/seo.ts: delete deadtechArticle()/howTo()(no call sites) whose guard comment claimed docs live in a separate Docusaurus app (false; this repo is Starlight)vite.config.ts,src/routes/index.tsx,routes/__root.tsx,lib/blog.ts) inflags.ts,index.astro,404.astro,BaseLayout.astro,blog.astrostyles.cssand the OG/markdown scripts; compress thestarlight.csscomment boxes to their invariants and drop theTODO(Phase 4)Skills
gpui-query-extensions: the bootstrap example documented ahydratecold-start step it never performed; the example now callshydrate(...)per the API documented in the same fileGates
cargo test --all-features: 795 passed, 0 failedcargo clippy --all-features --all-targets -- -D warnings: cleancargo doc --all-features --no-deps: zero warningsbun run buildinweb/: 29 pages, all stages cleangpui-query-legacywas audited too but left untouched (frozen per AGENTS.md).