Skip to content

docs: streamline README onboarding - #70

Merged
rodri-oliveira-dev merged 6 commits into
mainfrom
docs/68-streamline-readme
Sep 28, 2026
Merged

rodri-oliveira-dev merged 6 commits into
mainfrom
docs/68-streamline-readme

Conversation

@rodri-oliveira-dev

@rodri-oliveira-dev rodri-oliveira-dev commented Sep 28, 2026 •

Copy link
Copy Markdown
Owner

Summary

Reduces the onboarding density of both project READMEs while preserving the public contract and the essential delivery guarantees.

What changed

  • keeps purpose, installation, guarantees/boundaries, a package-only Quick Start, and minimal DI/dispatcher registration near the top;
  • keeps at-least-once semantics and the durable-store requirement explicit;
  • makes the non-durable scope of InMemoryWebhookDeliveryStore explicit;
  • replaces duplicated deep-dive material with a focused documentation map to production usage, persistence, the runnable sample, release scope, and security guidance;
  • keeps English and PT-BR READMEs factually equivalent.

Validation

  • Quick Start uses public v1.0.0 primitives already exercised by the repository (WebhookMessage, InMemoryWebhookDeliveryStore, InstrumentedWebhookDeliveryStore, WebhookHttpTransport, DefaultWebhookRetryPolicy, and WebhookDispatcher).
  • DI example matches the documented AddReliableWebhooks() / AddHostedDispatcher() API.
  • Referenced documentation paths were checked against the current repository layout.
  • Diff is limited to README.md and README.pt-BR.md.

Definition of Done

  • Purpose, installation, and first example are available without traversing internal documentation.
  • Quick Start is coherent with the published API.
  • Essential guarantees and limits remain visible.
  • Deep-dive content remains reachable through clear docs/ and sample links.
  • Conflicting duplication between README and deep documentation is reduced.
  • English and PT-BR READMEs remain factually equivalent.
  • Relevant links/snippets validated against the repository.
  • CI green.

Closes #68

Summary by CodeRabbit

  • Documentação
    • Reorganizados e condensados os guias de introdução em português e inglês, com informações sobre instalação, início rápido, fluxo de entrega e configuração mínima para produção.
    • Atualizados os exemplos de execução e adicionados links para documentação complementar. Detalhes operacionais, de segurança e de observabilidade foram removidos dessas páginas e direcionados a materiais específicos.

@coderabbitai

coderabbitai Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: Repository: rodri-oliveira-dev/ReliableWebhooks/https://raw.githubusercontent.com/rodri-oliveira-dev/.github/main/coderabbit-templates/dotnet-library.yaml (via .coderabbit.yaml)

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 9ba1acc7-3e65-4499-bdf4-f7164873dde5

📥 Commits

Reviewing files that changed from the base of the PR and between 198cb08 and 85498d0.

📒 Files selected for processing (2)
  • README.md
  • README.pt-BR.md
 ____________________________________________________________________________________________________________________________________
< Contrary to popular belief, Unix is user friendly. It just happens to be very selective about who it decides to make friends with. >
 ------------------------------------------------------------------------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7689b014d1

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md Outdated
@rodri-oliveira-dev
rodri-oliveira-dev merged commit 85e0f1a into main Sep 28, 2026
10 checks passed
@rodri-oliveira-dev
rodri-oliveira-dev deleted the docs/68-streamline-readme branch September 28, 2026 13:37
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.

Reduzir densidade do README e criar um caminho de onboarding mais curto

1 participant