Add missing frontmatter descriptions#522
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves SEO and link-preview quality across the IceRPC docs by adding missing description: frontmatter to content pages that previously rendered empty <meta name="description"> / OG / Twitter descriptions.
Changes:
- Add
description:frontmatter to Slice language-reference pages and key overviews. - Add
description:frontmatter to getting-started tutorials, installation pages, and supported-platforms pages. - Add
description:frontmatter to IceRPC-for-Ice-users overview and selected subpages.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| content/slice/language-reference/slice-grammar.md | Adds a frontmatter description for the Slice grammar reference page. |
| content/slice/language-reference/preprocessor-directives.md | Adds a frontmatter description for the Slice preprocessor directives reference page. |
| content/slice/language-reference/index.md | Adds a frontmatter description for the Slice language reference landing page. |
| content/slice/language-reference/doc-comments.md | Adds a frontmatter description for the Slice documentation comments reference page. |
| content/slice/encoding/overview.md | Adds a frontmatter description for the Slice encoding overview. |
| content/icerpc/slic-transport/overview.md | Adds a frontmatter description for the Slic transport overview. |
| content/icerpc-for-ice-users/index.md | Adds a frontmatter description for the “IceRPC for Ice users” landing page. |
| content/icerpc-for-ice-users/ice-definitions/language-mapping.md | Adds a frontmatter description for the Ice-to-C# mapping overview page. |
| content/icerpc-for-ice-users/ice-definitions/constants.md | Adds a frontmatter description for the constants/literals mapping page. |
| content/icerpc-for-ice-users/high-level-comparison/ice-reinvented.md | Adds a frontmatter description for the high-level comparison page. |
| content/getting-started/supported-platforms/icerpc-csharp-0_6.md | Adds a frontmatter description for supported platforms (C# 0.6). |
| content/getting-started/supported-platforms/icerpc-csharp-0_5.md | Adds a frontmatter description for supported platforms (C# 0.5). |
| content/getting-started/supported-platforms/icerpc-csharp-0_4.md | Adds a frontmatter description for supported platforms (C# 0.4). |
| content/getting-started/supported-platforms/icerpc-csharp-0_3.md | Adds a frontmatter description for supported platforms (C# 0.3). |
| content/getting-started/supported-platforms/icerpc-csharp-0_2.md | Adds a frontmatter description for supported platforms (C# 0.2). |
| content/getting-started/supported-platforms/icerpc-csharp-0_1.md | Adds a frontmatter description for supported platforms (C# 0.1). |
| content/getting-started/installation/template.md | Adds a frontmatter description for the .NET template installation/usage page. |
| content/getting-started/installation/existing-project.md | Adds a frontmatter description for the “existing project” installation page. |
| content/getting-started/icerpc-slice-tutorial/server-tutorial.md | Adds a frontmatter description for the IceRPC + Slice server tutorial. |
| content/getting-started/icerpc-slice-tutorial/client-tutorial.md | Adds a frontmatter description for the IceRPC + Slice client tutorial. |
| content/getting-started/icerpc-protobuf-tutorial/server-tutorial.md | Adds a frontmatter description for the IceRPC + Protobuf server tutorial. |
| content/getting-started/icerpc-protobuf-tutorial/client-tutorial.md | Adds a frontmatter description for the IceRPC + Protobuf client tutorial. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Adds a
description:to the 22 content pages that had none — without one, the page renders an empty<meta name="description">and empty OG/Twitter description, which hurts how these pages appear in search results and link previews.The affected pages were the four tutorials, the template/existing-project installation pages, all six supported-platforms pages, the entire Slice language-reference section, the Slice encoding and Slic transport overviews, and a few icerpc-for-ice-users pages. Where a nav card already described the page (tutorials, installation, Slice encoding), the description reuses that card's copy verbatim; the rest are new one-liners written in the same style — worth a quick read since they're new user-facing copy.
🤖 Generated with Claude Code