docs: cleanup and consistency improvements across README, CONTRIBUTING, and component docs#67
Draft
NikolayS wants to merge 1 commit into
Draft
docs: cleanup and consistency improvements across README, CONTRIBUTING, and component docs#67NikolayS wants to merge 1 commit into
NikolayS wants to merge 1 commit into
Conversation
…G, and component docs
- Remove orphaned scratch design doc TMP_MON_PREVIEWS.md (1518 lines,
duplicate changelog entries, not referenced; replaced by
preview-infra/RUNBOOK.md).
- Fix broken markdown in README.md: remove broken centered-div wrap
that left code blocks center-aligned, drop duplicated "Use cases"
section, fix unterminated backtick, consolidate Links/Support, and
drop decorative emoji from H2 headers for consistency with the top
half of the document.
- Fix stale repo URL in cli/README.md (postgres_ai -> postgresai).
- Fix invalid check ID in QUALITY_ENGINEERING_GUIDE example summary
(U001 -> H002, D004 -> F004) and correct CLI command reference
(postgresai monitoring -> postgresai mon).
- Fix stray "SQL" delimiter outside heredoc and reschedule mismatch
("every 20 minutes" did not match the daily cron) in
workload_examples/single_index_analysis.md.
- Normalize curly quotes to ASCII in CONTRIBUTING.md and
components/index_pilot docs, tighten Recommendations wording.
- Minor SECURITY.md heading casing and grammar fixes.
- Trim trailing blank lines in pgai/README.md, postgres_ai_helm/README.md,
components/index_pilot/CONTRIBUTING.md.
https://claude.ai/code/session_01U4F5KjW5neeCYxkKUZawfS
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
2 participants
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
TMP_MON_PREVIEWS.md(1518 lines, prefixedTMP_, contained duplicate changelog entries, not referenced anywhere; the same content lives inpreview-infra/RUNBOOK.mdand related code).README.md: a stray inner<div align="center">was center-aligning all bottom-half sections (Upgrading, K8s, Checkup reports, etc.), and a duplicated "Use cases" block repeated the top of the document. Reflowed the file, consolidated Links/Support into a single table at the end, dropped decorative emoji from H2 headers to match the cleaner top half, fixed an unterminated backtick.postgres_ai/-/issues->postgresai/-/issuesincli/README.md; invalid check IDsU001/D004-> real IDsH002/F004inquality/QUALITY_ENGINEERING_GUIDE.md;postgresai monitoring->postgresai monin the same file; straySQLoutside a heredoc and a schedule mismatch ("every 20 minutes" vs daily cron) inworkload_examples/single_index_analysis.md.CONTRIBUTING.md,components/index_pilot/README.md,components/index_pilot/CONTRIBUTING.md; minor heading/grammar fixes inSECURITY.md; trimmed trailing blank lines inpgai/README.mdandpostgres_ai_helm/README.md.No code, config, or behavior changes —
.mdfiles only.Test plan
postgresai/-/issues)postgresai mon, check IDs H002/H004/F004/K003)TMP_MON_PREVIEWS.mddeletion is intended (content is preserved bypreview-infra/RUNBOOK.mdand the existing implementation underpreview-infra/)https://claude.ai/code/session_01U4F5KjW5neeCYxkKUZawfS
Generated by Claude Code