Skip to content

Bring Neon and MySQL to parity across all docs#32

Open
teknogeek0 wants to merge 1 commit into
mainfrom
docs/neon-mysql-parity
Open

Bring Neon and MySQL to parity across all docs#32
teknogeek0 wants to merge 1 commit into
mainfrom
docs/neon-mysql-parity

Conversation

@teknogeek0
Copy link
Copy Markdown
Collaborator

Summary

Post-1.2.0 docs audit. Reviewed every .md file in the repo for places where Neon or MySQL/Vitess should be mentioned alongside the other providers/engines but were missing. Fills in the gaps.

Changes

File Change
README.md Overview now mentions MySQL/Vitess
docs/performance_considerations.md Managed-services list includes Heroku Postgres and Neon
docs/providers/README.md Adds neon install line, neon to JSON-output example, drops the stale Provider Comparison table
sql_discovery/README.md Managed PG services list now includes Supabase and Neon
docs/troubleshooting.md Managed-services list broadened to include Supabase, Heroku Postgres, Neon
docs/providers/aws.md Overview line notes PostgreSQL and MySQL engines
docs/providers/gcp.md Overview line notes PostgreSQL and MySQL engines
docs/mysql.md New callout: MySQL discovery supported on AWS/GCP, the Supabase/Heroku/Neon providers are PostgreSQL-only

Test plan

  • Diff is purely textual additions — no code or workflow changes
  • grep -ciE 'neon|mysql' recount across all .md files confirms no other gaps

Picks up the missing provider/engine mentions surfaced by an audit of
every .md file in the repo after the 1.2.0 release:

- README.md: mention MySQL/Vitess in the overview
- docs/performance_considerations.md: include Heroku Postgres + Neon
  in the managed-services list
- docs/providers/README.md: add neon install line, neon to the JSON
  output example, drop the stale (now-incomplete) Provider Comparison
  table
- sql_discovery/README.md: add Supabase and Neon to the managed PG
  services the standalone SQL script supports
- docs/troubleshooting.md: broaden the managed-services list to match
- docs/providers/aws.md: note PostgreSQL and MySQL engines in the
  Aurora/RDS overview line
- docs/providers/gcp.md: note PostgreSQL and MySQL engines in the
  Cloud SQL overview line
- docs/mysql.md: callout clarifying that AWS and GCP cloud analyzers
  cover MySQL, but the Supabase/Heroku/Neon providers are Postgres-only
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant