Skip to content

README: launch-oriented top section (EN/pt-BR) - #3

Merged
leoars merged 1 commit into
mainfrom
readme-launch-top
Nov 1, 2026
Merged

leoars merged 1 commit into
mainfrom
readme-launch-top

Conversation

@leoars

@leoars leoars commented Nov 1, 2026

Copy link
Copy Markdown
Owner

What changed / O que mudou

Top of README.md and README.pt-BR.md, from the description paragraph to the screenshot: one-line value proposition, download line (graphical installer or portable ZIP, .NET runtime included, PostgreSQL 17/18), screenshot with alt text only, a quoted pre-release notice linking to the validation guide and release notes, and a new "Why PGMS / Por que o PGMS" list. "Get started / Começar" is now split into "Install / Instalar" and "Build from source / Compilar a partir do código"; the build text and PowerShell block are unchanged. The image provenance caption moved to docs/assets/README.md. Badges, Features, Documentation, Contribute and License sections are unchanged.

Content direction comes from a handoff approved by the maintainer. Adjustments against that proposal: the draft-recovery bullet says "checkpointed and recovered after a crash or forced close" (the public user guide and the recovery acceptance cover interruption with periodic checkpoints, not every last keystroke); the pre-release notice keeps the explicit sentence that full SSMS parity is not claimed; no Query Statistics bullet was added because that feature is not part of the published alpha.1 source.

Why / Por quê

The previous top addressed project developers (internal build label, parity disclaimers first). For a public launch the top should address a first-time visitor, while keeping every scope limit reachable by link.

Validation actually run / Validação realmente executada

  • scripts/Test-PublicDocumentation.ps1: Valid = True, 15 language pairs, 32 public documents, 180 local links, CommandsMatch = True.
  • git diff --check: clean.
  • No code changed; Build.ps1 and Test-Integration.ps1 were not run for this documentation-only change.

Checklist

  • No credentials, personal data, dumps, saved profiles or local artifacts are included. / Sem credenciais, dados pessoais, dumps, perfis salvos ou artefatos locais.
  • Tests used only synthetic data and the isolated project cluster. / Testes usaram apenas dados sintéticos e o cluster isolado do projeto. (documentation only)
  • Public documentation updated in both docs/en and docs/pt-BR (and both READMEs) when relevant. / Documentação pública atualizada em docs/en e docs/pt-BR (e nos dois READMEs) quando pertinente.
  • No SSMS parity or platform certification is claimed beyond what was tested. / Nenhuma paridade com SSMS ou certificação de plataforma declarada além do testado.
  • Known limits of the change are stated above. / Limites conhecidos da mudança estão descritos acima.

🤖 Generated with Claude Code

Proposta de valor, download e requisitos em uma linha, seção "Why PGMS",
aviso de escopo por link ao guia de validação, legenda de proveniência da
imagem movida para docs/assets/README.md e "Get started" dividido em
Install / Build from source. Badges e demais seções inalterados.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@leoars
leoars merged commit ab4e29b into main Nov 1, 2026
1 check passed
@leoars
leoars deleted the readme-launch-top branch November 1, 2026 04:53
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