Document 0.6 installation, packaging, and supported platforms#499
Open
pepone wants to merge 1 commit into
Open
Document 0.6 installation, packaging, and supported platforms#499pepone wants to merge 1 commit into
pepone wants to merge 1 commit into
Conversation
- existing-project.md: add an "IceRPC and Ice packages" section for the .ice / Ice-interop path (IceRpc.Ice + ZeroC.Ice.Slice.Tools), and a "Build telemetry" section documenting the on-by-default telemetry and the IceRpcBuildTelemetry=false opt-out. - language-mapping.md: complete the .ice project-file example with the required IceRpc.Ice package and PrivateAssets="All" on the tools package; explain both packages. - nuget-packages.md: update the IceRpc.Slice.Tools description to reflect the slicec compiler + C# generator plug-ins (no longer monolithic). - supported-platforms/icerpc-csharp-0_6.md: add the 0.6 platforms page; repoint the contentMap.json nav link from the 0.5 page to it.
There was a problem hiding this comment.
Pull request overview
This PR updates the IceRPC 0.6 documentation to close installation/packaging gaps and add a new supported-platforms page, including navigation updates to point to the 0.6 platform matrix.
Changes:
- Add guidance for Ice interop /
.icecompilation packages and document default build telemetry + opt-out. - Fix the
.iceMSBuild example to include the required runtime package and clarify the build-time tools dependency. - Add the IceRPC for C# 0.6 supported-platforms page and repoint navigation to it.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| data/contentMap.json | Updates the “Supported platforms” nav link to the new 0.6 page. |
| content/icerpc-for-ice-users/ice-definitions/language-mapping.md | Completes the .ice project example with required packages and clarifies tool/runtime roles. |
| content/getting-started/supported-platforms/icerpc-csharp-0_6.md | Adds the IceRPC for C# 0.6 supported platforms matrix and back-links to prior versions. |
| content/getting-started/installation/nuget-packages.md | Updates IceRpc.Slice.Tools description to mention the slicec compiler. |
| content/getting-started/installation/existing-project.md | Adds “IceRPC and Ice packages” plus a new “Build telemetry” section and opt-out instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| or | ||
| Instead of setting `IceRpc="true"` on each `SliceCompile` item, you can make icerpc the default RPC framework for all |
|
|
||
| ```xml | ||
| <!-- Set the default RPC framework for .ice file compilation to icerpc --> | ||
| <!-- Set the default RPC framework for .ice file compilation to icerpc --> |
| | [IceRpc.ServiceGenerator] | C# source generator enabled by the `[Service]` attribute. | | ||
| | [IceRpc.Slice] | IceRPC + Slice integration library | | ||
| | [IceRpc.Slice.Tools] | Slice compiler, code generators for C#, and MSBuild support | | ||
| | [IceRpc.Slice.Tools] | Slice compiler slicec, the C# code generators, and MSBuild support | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fills the under-documented "new in 0.6" installation/packaging gaps found in the docs review.
Changes
existing-project.md.ice/ Ice-interop path (IceRpc.Ice+ZeroC.Ice.Slice.Tools), mirroring the existing Slice/Protobuf sections.<IceRpcBuildTelemetry>false</IceRpcBuildTelemetry>opt-out, with links to the tooling READMEs.language-mapping.md— the.iceproject-file example was missing the requiredIceRpc.Icepackage (without it the generated*.IceRpc.cscode doesn't compile) andPrivateAssets="All"on the tools package. Completed it to match the canonicalexamples/ice/Greetercsproj, and explained both packages.nuget-packages.md— updated theIceRpc.Slice.Toolsdescription to reflect the new architecture (sliceccompiler driving C# generator plug-ins) instead of implying a monolithic compiler.supported-platforms/icerpc-csharp-0_6.md(new) — added the 0.6 supported-platforms page; repointed thedata/contentMap.jsonnav link from the 0.5 page to it.Part of a 3-PR series addressing the 0.6.0 docs review. This is PR 2/3 (important gaps).