Skip to content

Update docs - #3115

Merged
timostamm merged 2 commits into
mainfrom
ajeet/fix-markdown-docs
Nov 2, 2026
Merged

timostamm merged 2 commits into
mainfrom
ajeet/fix-markdown-docs

Conversation

@ajeetdsouza

@ajeetdsouza ajeetdsouza commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Did a quick pass over our docs. This PR:

  • Sections of buf.gen.yaml now contain the prefix:
    # You will need to adapt these values to your environment:
    # https://protobufes.com/reference/environments/
  • Fixes prose that had drifted from the code
    • CONTRIBUTING pointed to ./manage.mjs test, which doesn't exist; it now says ./manage.mjs ci
    • express tests use the Node.js test runner, not Jasmine
    • remix builds with esbuild (classic Remix compiler), not Rollup
    • vue tests use Vue Test Utils, not Vue Testing Library
    • astro dev runs on port 4321 and svelte preview on port 4173, not 3000
    • bundle-size imports SayRequestSchema and SayVolumeSchema, not SayRequest
    • cloudflare-workers linked to url-shortener.spec.ts; the file is url-shortener.test.ts
  • Fixes broken URLs, and updates redirected ones and the upgrade-guide links in CONTRIBUTING to the framework versions we use today
  • Fixes a reversed Markdown link in the nextjs README, and moves the react-native Metro section out of the middle of the command list
  • Uses bash for all shell blocks, with no $ prompts so it's easier to copy
  • Adds minor consistency, formatting, spelling, and grammar fixes

Signed-off-by: Ajeet D'Souza <98ajeet@gmail.com>
Signed-off-by: Ajeet D'Souza <98ajeet@gmail.com>
@ajeetdsouza
ajeetdsouza requested a review from timostamm October 29, 2026 12:58
@ajeetdsouza
ajeetdsouza marked this pull request as ready for review October 29, 2026 12:58
@timostamm
timostamm merged commit cf4cc7b into main Nov 2, 2026
25 checks passed
@timostamm
timostamm deleted the ajeet/fix-markdown-docs branch November 2, 2026 15:07
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.

3 participants