Skip to content

Commit

Permalink
Add content to docfx index.md (#3656)
Browse files Browse the repository at this point in the history
  • Loading branch information
pepone authored Sep 18, 2023
1 parent e78fe5c commit 6a05048
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docfx/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"_appName": "API",
"_appFaviconPath": "images/favicon.ico",
"_appLogoPath": "images/logo.svg",
"_appLogoUrl": "https://docs.icerpc.dev/api/csharp/api/IceRpc.html",
"_appLogoUrl": "https://docs.icerpc.dev/api/csharp/index.html",
"_appFooter": "© 2023 ZeroC",
"_enableSearch": true,
"_gitContribute": {
Expand Down
51 changes: 47 additions & 4 deletions docfx/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,47 @@
# This is the **HOMEPAGE**.
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
## Quick Start Notes:
1. Add images to the *images* folder if the file is referencing an image.
---
layout: landing
---

# IceRPC for C# API Reference

| Namespace | Description |
|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| [IceRpc] | The core of the IceRPC framework and various extensions for this core. |
| [IceRpc.Compressor] | Provides the compressor interceptor and middleware, for compressing and decompressing the payloads of requests and responses. |
| [IceRpc.Deadline] | Provides the deadline interceptor and middleware. |
| [IceRpc.Extensions.DependencyInjection] | Provides APIs related to Dependency Injection. |
| [IceRpc.Features] | Provides the feature collection API and the core request features. |
| [IceRpc.Locator] | Provides the locator interceptor. This interceptor enables interop with Ice servers registered with a locator such as IceGrid. |
| [IceRpc.Logger] | Provides the logger interceptor and middleware, for logging requests and responses to an ILogger. |
| [IceRpc.Metrics] | Provides the metrics interceptor and middleware. |
| [IceRpc.RequestContext] | Provides the request context interceptor and middleware. |
| [IceRpc.Retry] | Provides the retry interceptor. |
| [IceRpc.Slice] | Provides support for the IceRPC + Slice integration. The Slice compiler for C# generates code for Slice interfaces that relies on these APIs. |
| [IceRpc.Slice.Ice] | Provides Ice-specific APIs, for interop with Ice applications. |
| [IceRpc.Telemetry] | Provides the telemetry interceptor and middleware; they add [OpenTelemetry] support to IceRPC. |
| [IceRpc.Transports] | Provides the duplex and multiplexed transport abstractions. |
| [IceRpc.Transports.Coloc] | Provides the coloc duplex transport. It implements the duplex transport abstractions for "colocated" communications within the same address space. |
| [IceRpc.Transports.Quic] | Provides the QUIC multiplexed transport. It implements the multiplexed transport abstractions using QUIC. |
| [IceRpc.Transports.Slic] | Provides the Slic multiplexing adapter. Slic implements the multiplexed transport abstractions over the duplex transport abstractions. |
| [IceRpc.Transports.Tcp] | Provides the TCP duplex transport. It implements the duplex transport abstractions using plain TCP and TCP + SSL. |
| [ZeroC.Slice] | Supports encoding/decoding structured data to/from bytes in the Slice format. The Slice compiler for C# generates code that relies on these APIs. |

[IceRpc]: api/IceRpc.yml
[IceRpc.Compressor]: api/IceRpc.Compressor.yml
[IceRpc.Deadline]: api/IceRpc.Deadline.yml
[IceRpc.Extensions.DependencyInjection]: api/IceRpc.Extensions.DependencyInjection.yml
[IceRpc.Features]: api/IceRpc.Features.yml
[IceRpc.Locator]: api/IceRpc.Locator.yml
[IceRpc.Logger]: api/IceRpc.Logger.yml
[IceRpc.Metrics]: api/IceRpc.Metrics.yml
[IceRpc.RequestContext]: api/IceRpc.RequestContext.yml
[IceRpc.Retry]: api/IceRpc.Retry.yml
[IceRpc.Slice]: api/IceRpc.Slice.yml
[IceRpc.Slice.Ice]: api/IceRpc.Slice.Ice.yml
[IceRpc.Telemetry]: api/IceRpc.Telemetry.yml
[IceRpc.Transports]: api/IceRpc.Transports.yml
[IceRpc.Transports.Coloc]: api/IceRpc.Transports.Coloc.yml
[IceRpc.Transports.Quic]: api/IceRpc.Transports.Quic.yml
[IceRpc.Transports.Slic]: api/IceRpc.Transports.Slic.yml
[IceRpc.Transports.Tcp]: api/IceRpc.Transports.Tcp.yml
[ZeroC.Slice]: api/ZeroC.Slice.yml
2 changes: 1 addition & 1 deletion docfx/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
href: https://docs.icerpc.dev/icerpc-for-ice-users

- name: API Reference
href: api/
href: index.md

0 comments on commit 6a05048

Please sign in to comment.