Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Getting started draft #40

Merged
merged 6 commits into from
May 3, 2023
Merged

Getting started draft #40

merged 6 commits into from
May 3, 2023

Conversation

pepone
Copy link
Member

@pepone pepone commented Apr 25, 2023

This is a draft for the getting started page

@@ -1,23 +1,88 @@
---
title: Writing your first IceRPC application
description: TODO
title: Writing your first IceRPC application in C#
Copy link
Member

Choose a reason for hiding this comment

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

I would leave this as "Writing your first IceRPC application". In the future when we have icerpc-rs we would use this same page for getting started and just use a language selector to change the content on the page.

Copy link
Member Author

Choose a reason for hiding this comment

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

does this imply we will have the content for all languages on this document?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it makes sense to use separate pages in this case, I belive this documents would be very different for each language,

Copy link
Member

Choose a reason for hiding this comment

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

From the users perspective though the dont care how we internally represent the pages. All they care about is that they select their language and that they only see content relevant for that language.

MarkDoc supports a feature called partials where for longer pages we could split the markdown into seprate files and pull it into a page https://markdoc.dev/docs/partials#partials. This could be a solution when we start thinking about other languages.

pages/docs/getting-started/writing-an-application.md Outdated Show resolved Hide resolved
pages/docs/getting-started/writing-an-application.md Outdated Show resolved Hide resolved
pages/docs/getting-started/writing-an-application.md Outdated Show resolved Hide resolved
pages/docs/getting-started/writing-an-application.md Outdated Show resolved Hide resolved
pages/docs/getting-started/writing-an-application.md Outdated Show resolved Hide resolved
pages/docs/getting-started/writing-an-application.md Outdated Show resolved Hide resolved
@pepone pepone marked this pull request as ready for review May 3, 2023 14:55
@@ -29,13 +30,15 @@
"Renderable",
"RFCOMM",
"Roboto",
"rpcs",
Copy link
Member

Choose a reason for hiding this comment

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

Why do we need rpcs?

I would avoid the plural and rpc should be spelled RPC not rpc.

Copy link
Member Author

Choose a reason for hiding this comment

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

I added this because spell check job was failing,

data\icerpc-core-data.ts
140:        path: `${RPC_CORE_BASE_URL}/icerpc-protocol/mapping-rpcs-to-streams

Copy link
Member

@ReeceHumphreys ReeceHumphreys left a comment

Choose a reason for hiding this comment

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

Looks good

@pepone pepone merged commit aa138d2 into icerpc:main May 3, 2023
1 check failed
@pepone pepone mentioned this pull request May 3, 2023
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.

None yet

3 participants