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

Reorganize the C# Guide around a new C# hub page #39916

Merged
merged 14 commits into from
Mar 29, 2024

Conversation

BillWagner
Copy link
Member

@BillWagner BillWagner commented Mar 12, 2024

Fixes #39820
Fixes #40154

  1. Create sub-TOC for specifications, along with a landing page for language specs.
  2. Create sub-TOC for language reference, along with a landing page for the language reference. This required also updating or removing links to the previous index page. The links to the index was removed from pages in the language reference. In other areas, the link was updated to point at the new YML file.
  3. Incorporate compiler errors messages into the language reference TOC.
  4. Create new C# hub page.

Primary files changed:

The two new landing pages move that content out of the main conceptual TOC, which makes it more stand-alone. readers are less likely to fall into it by accident.

Most of the remaining files changed by removing a link to the overview page of the language reference. That seems redundant for language reference pages, as that page is the top page in the TOC.


Internal previews

Toggle expand/collapse
📄 File 🔗 Preview link
docs/csharp/fundamentals/exceptions/exception-handling.md Exception Handling (C# Programming Guide)
docs/csharp/language-reference/builtin-types/bool.md "bool type - C# reference"
docs/csharp/language-reference/builtin-types/built-in-types.md Built-in types (C# reference)
docs/csharp/language-reference/builtin-types/char.md char (C# reference)
docs/csharp/language-reference/builtin-types/default-values.md docs/csharp/language-reference/builtin-types/default-values
docs/csharp/language-reference/builtin-types/enum.md Enumeration types (C# reference)
docs/csharp/language-reference/builtin-types/floating-point-numeric-types.md Floating-point numeric types (C# reference)
docs/csharp/language-reference/builtin-types/integral-numeric-types.md Integral numeric types (C# reference)
docs/csharp/language-reference/builtin-types/nullable-reference-types.md "Nullable reference types - C# reference"
docs/csharp/language-reference/builtin-types/nullable-value-types.md Nullable value types (C# reference)
docs/csharp/language-reference/builtin-types/numeric-conversions.md Built-in numeric conversions (C# reference)
docs/csharp/language-reference/builtin-types/record.md docs/csharp/language-reference/builtin-types/record
docs/csharp/language-reference/builtin-types/ref-struct.md ref structure types (C# reference)
docs/csharp/language-reference/builtin-types/reference-types.md Built-in reference types (C# reference)
docs/csharp/language-reference/builtin-types/struct.md "Structure types - C# reference"
docs/csharp/language-reference/builtin-types/unmanaged-types.md Unmanaged types (C# reference)
docs/csharp/language-reference/builtin-types/value-tuples.md Tuple types (C# reference)
docs/csharp/language-reference/builtin-types/value-types.md Value types (C# reference)
docs/csharp/language-reference/builtin-types/void.md "void - C# reference"
docs/csharp/language-reference/keywords/abstract.md abstract (C# Reference)
docs/csharp/language-reference/keywords/access-modifiers.md docs/csharp/language-reference/keywords/access-modifiers
docs/csharp/language-reference/keywords/accessibility-domain.md Accessibility Domain (C# Reference)
docs/csharp/language-reference/keywords/accessibility-levels.md Accessibility Levels (C# Reference)
docs/csharp/language-reference/keywords/ascending.md "ascending - C# Reference"
docs/csharp/language-reference/keywords/index.md C# Keywords
docs/csharp/language-reference/keywords/out.md out (C# Reference)
docs/csharp/language-reference/tokens/index.md C# Special Characters
docs/csharp/misc/sorry-we-don-t-have-specifics-on-this-csharp-error.md Sorry, we don't have specifics on this C# error
docs/csharp/programming-guide/classes-and-structs/implicitly-typed-local-variables.md docs/csharp/programming-guide/classes-and-structs/implicitly-typed-local-variables
docs/csharp/specification/overview.md C# standard specification

Note
This table shows preview links for the 30 files with the most changes. For preview links for other files in this PR, select OpenPublishing.Build Details within checks.

@katiesavage
Copy link
Contributor

Suggested learning resources for the CTA are:

@katiesavage
Copy link
Contributor

I also wonder if we should add the 'concepts' from the original C# index page into the "language concepts" section:
image

@BillWagner BillWagner force-pushed the create-csharp-hub branch 3 times, most recently from f1766ee to d2dda20 Compare March 21, 2024 13:24
@BillWagner BillWagner marked this pull request as ready for review March 21, 2024 13:41
@BillWagner BillWagner requested a review from a team as a code owner March 21, 2024 13:41
@BillWagner
Copy link
Member Author

The MS Docs build verifier error is false positive: It's because index.md changed to index.yml in the C# root folder. Adding a redirection for that fails the OPS build.

@BillWagner
Copy link
Member Author

BillWagner commented Mar 21, 2024

@jamesmontemagno @claudiaregio @katiesavage @KathleenDollard @raprice

This is ready to merge. I tagged all of you for review if you want to take another look.

@katiesavage
Copy link
Contributor

One idea - for the link to VS Code, should we send users to the C# get started page? This page includes instructions about installing the C# Dev Kit extension

docs/csharp/index.yml Outdated Show resolved Hide resolved
docs/csharp/index.yml Outdated Show resolved Hide resolved
docs/csharp/index.yml Show resolved Hide resolved
docs/csharp/index.yml Outdated Show resolved Hide resolved
docs/csharp/index.yml Outdated Show resolved Hide resolved
BillWagner and others added 13 commits March 29, 2024 09:35
Create a new TOC for the specification.
Move content to be displayed there.

Create spec landing page
Create a landing page for the C# language reference. Create a new TOC for the reference only.
Remove or update links to the old landing page to point at the new page.
Co-authored-by: Katie Savage <KATIESAVAGE@microsoft.com>
Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

Looks great!

docs/csharp/index.yml Outdated Show resolved Hide resolved
docs/csharp/index.yml Outdated Show resolved Hide resolved
docs/csharp/index.yml Outdated Show resolved Hide resolved
docs/csharp/index.yml Outdated Show resolved Hide resolved
docs/csharp/index.yml Outdated Show resolved Hide resolved
docs/csharp/language-reference/toc.yml Outdated Show resolved Hide resolved
docs/csharp/language-reference/toc.yml Outdated Show resolved Hide resolved
docs/csharp/language-reference/toc.yml Show resolved Hide resolved
docs/csharp/specification/toc.yml Outdated Show resolved Hide resolved
docs/csharp/index.yml Outdated Show resolved Hide resolved
docs/csharp/index.yml Outdated Show resolved Hide resolved
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@BillWagner
Copy link
Member Author

Thanks a lot @gewarren That was awesome!

@BillWagner BillWagner enabled auto-merge (squash) March 29, 2024 19:29
@BillWagner BillWagner merged commit 6cb9904 into dotnet:main Mar 29, 2024
7 of 8 checks passed
@BillWagner BillWagner deleted the create-csharp-hub branch March 29, 2024 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create C# Hub page Create C# hub page
4 participants