Skip to content

Fix typos across docs content#515

Merged
externl merged 2 commits into
icerpc:mainfrom
externl:fix-content-typos
Jul 8, 2026
Merged

Fix typos across docs content#515
externl merged 2 commits into
icerpc:mainfrom
externl:fix-content-typos

Conversation

@externl

@externl externl commented Jul 7, 2026

Copy link
Copy Markdown
Member

Fixes ~40 typos across 34 content pages, found during a full editorial review of the docs.

Most are one-word fixes: misspellings (carycarry, built-itbuilt-in, ore/orior, thanthat, "Lean" → "Learn"), duplicated words ("for for", "the the"), wrong names (Programs.csProgram.cs, Compress-FlagCompressed-Flag, the cs:: "suffix" that is actually a prefix), and casing ("IceRpc + Slice" → "IceRPC + Slice", "Quic" → "QUIC", greetGreet). It also code-formats a few Slic frame names (Initialize, InitializeAck, StreamLast) that were plain text and fixes minor punctuation: a missing space after a period, a stray backtick, a double space, -- → em dash, and two garbled frontmatter descriptions.

No meaning changes beyond the corrections themselves.

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings July 7, 2026 15:33

Copilot AI 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.

Pull request overview

This PR applies an editorial pass across the documentation site, correcting spelling/grammar, terminology/casing (e.g., “IceRPC”, “QUIC”), and a few formatting issues in code/grammar snippets without intended meaning changes.

Changes:

  • Fixes numerous typos/grammar issues across Slice, IceRPC, and Protobuf documentation pages.
  • Normalizes terminology/casing and code formatting in examples and protocol/frame names.
  • Cleans up minor punctuation/formatting issues in prose and frontmatter.

Reviewed changes

Copilot reviewed 33 out of 34 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
content/slice/language-reference/slice-grammar.md Capitalization/wording fixes in Slice file/module prose.
content/slice/language-reference/preprocessor-directives.md Fixes a typo in the conditional grammar production.
content/slice/language-reference/index.md Fixes missing space after a period in prose.
content/slice/language-guide/well-known-types.md Corrects “Universally Unique Identifier” wording.
content/slice/language-guide/using-proxies-as-slice-types.md Fixes frontmatter description grammar.
content/slice/language-guide/struct-types.md Replaces -- with an em dash in prose.
content/slice/language-guide/result-types.md Fixes a typo in a C# comment in an example.
content/slice/language-guide/operation.md Corrects formatting of “NameProxy” reference in note.
content/slice/language-guide/enum-types.md Fixes a typo in a Slice example comment.
content/slice/language-guide/attributes.md Corrects “cs::” being a prefix (not suffix).
content/slice/index.md Adds missing punctuation in a card description.
content/slice/encoding/overview.md Improves line-wrapping/formatting in introductory prose.
content/slice/basics/contract-first.md Hyphenates “Contract-first” in title.
content/protobuf/language-mapping/service.md Improves wording and comments in C# mapping examples.
content/protobuf/encoding.md Corrects “Compressed-Flag” naming in framing description.
content/icerpc/slic-transport/streams.md Fixes multiple typos and code-formatting for frame names.
content/icerpc/slic-transport/protocol-frames.md Code-formats Initialize reference in prose.
content/icerpc/slic-transport/connection-establishment.md Fixes spacing and code-formatting in establishment steps.
content/icerpc/protocols-and-transports/icerpc-multiplexed-transports.md Fixes “Lean” → “Learn” in frontmatter description.
content/icerpc/protocol-connection.md Normalizes “TCP” casing in prose.
content/icerpc/multiplexed-transport.md Normalizes “QUIC” casing in prose.
content/icerpc/invocation/service-address.md Fixes “ori” → “or” in service-address prose.
content/icerpc/invocation/invocation-pipeline.md Fixes “built-it” → “built-in” typo.
content/icerpc/invocation/interceptor.md Removes a stray backtick/punctuation error.
content/icerpc/dispatch/router.md Fixes “than” → “that” in router definition.
content/icerpc/dispatch/dispatch-pipeline.md Fixes “built-it” and “ore” typos.
content/icerpc/dependency-injection/dispatch-pipeline-with-di.md Fixes “scope” → “scoped” in code comment.
content/icerpc-for-ice-users/rpc-core/ice-identity.md Fixes “path” → “paths” in frontmatter description.
content/icerpc-for-ice-users/high-level-comparison/ice-reinvented.md Removes duplicated word (“for for”).
content/getting-started/quickstart.md Normalizes “IceRPC” casing in tutorial links.
content/getting-started/installation/nuget-packages.md Fixes punctuation consistency in a package description.
content/getting-started/icerpc-slice-tutorial/server-tutorial.md Fixes Programs.csProgram.cs filename reference.
content/getting-started/icerpc-protobuf-tutorial/server-tutorial.md Fixes Programs.csProgram.cs filename reference.
content/getting-started/icerpc-protobuf-tutorial/client-tutorial.md Normalizes request name casing (greetGreet).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

public partial interface IWidgetService
{
// One method per operation
// One method per rpc method

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done in 3ad6355 — capitalized here and also in the parallel client-side comment on line 75 ("One C# method per RPC method") so the two generated-code comments match the page's prose ("RPC method").

Comment on lines +91 to +92
- [Writing your first IceRPC + Slice server application][slice-server-tutorial]
- [Writing your first IceRPC + Slice client application][slice-client-tutorial]

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Casing rationale: IceRPC is the name of the project (used in prose), while IceRpc is reserved for C# artifacts (namespace IceRpc;, using IceRpc;, package names like IceRpc.Slice.Tools). These two lines are link text — prose — and the linked tutorials are titled "Writing your first IceRPC + Slice server/client in C#", so prose casing applies. With this change, every remaining IceRpc under content/ appears only in code contexts.

```

The client sends a single `greet` request to the service hosted by our server:
The client sends a single `Greet` request to the service hosted by our server:

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Why Greet (PascalCase): the Protobuf contract on this page defines rpc Greet (GreetRequest) returns (GreetResponse);, the prose earlier on this page already says "the client sends a Greet request", and the captured log output directly below shows the actual operation name on the wire: Sent request Greet to icerpc:/visitor_center.Greeter.

The lowercase greet was copied from the Slice tutorial, where it is correct — Slice operations are camelCase (greet(name: string) -> string) and its log correspondingly shows Sent request greet.

@InsertCreativityHere InsertCreativityHere left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good to me!


The state machine doesn't have the `WaitForAppConsume` state because the stream's read-side doesn't need to notify the
peer that its done reading.
peer that it's done reading.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

it's

👍

@externl externl merged commit ae53b0c into icerpc:main Jul 8, 2026
9 checks passed
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.

4 participants