-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Update Navigation for "What's New" section in C#. #9360
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
Update Navigation for "What's New" section in C#. #9360
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good, @BillWagner. I've left a few comments for you to consider.
.openpublishing.redirection.json
Outdated
| "redirect_document_id": false | ||
| }, | ||
| { | ||
| "source_path": "docs/csharp/whats-new/index.md", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem with this redirection is that it needs to be revised for each new version, which is a maintenance issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be easier to do the redirection in the index.md file directly
We've strived for hackable URLs throughout the .NET docset. That has sometimes meant we have index.md files in directories where they don't add much value. This PR is an experiment which tries the following with the C# Guide: . Removes `whats-new/index.md` . Redirects that traffic to `whats-new/csharp-7-3` (which is currently the latest version. This PR **does not ** update the TOC.md file, bcause the JavaScript code that hightlights the current page breaks when multiple nodes in the TOC refer to the same file. This PR also **does not** change any other links pointing to the index.md file on the assumption that those links should track the current "laster" version.
A few related changes here: - Incorporate important bits from "what's new" index. - Update hub page with link for "What's New", and remove redundant link. - Fix bad link.
Respond to feedback / Part 1
d31597d to
d2ecbd2
Compare
| This article provides a history of each major release of the C# language. The C# team is continuing to innovate and add new features. Detailed language feature status, including features considered for upcoming releases can be found [on the dotnet/roslyn repository](https://github.com/dotnet/roslyn/blob/master/docs/Language%20Feature%20Status.md) on GitHub. | ||
|
|
||
| > [!IMPORTANT] | ||
| > The C# language relies on types and method in what the C# specification defines as a *standard library* for some of the features. The .NET platform delivers those types and methods in a number of packages. One example is exception processing. Every `throw` statement or expression is checked to ensure the object being thrown is derived from <xref:System.Exception>. Similarly, every `catch` is checked to ensure that the type being caught is derived from <xref:System.Exception>. Each version may add new requirements. To use the latest language features in older environments, you may need to install specific libraries. These dependencies are documented in the page for each specific version. You can learn more about the [relationships between language and library](relationships-between-language-and-library.md) for background on this dependency. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The C# language relies on types and method
s.... I'll edit and fix this 😄
We've strived for hackable URLs throughout the .NET docset. That has sometimes meant we have index.md files in directories where they don't add much value.
This PR makes several navigation changes:
. Removes
whats-new/index.md. Redirects that traffic to
whats-new/csharp-7-3(which is currently the latest version.This PR does not change any other links pointing to the index.md file on the assumption that those links should track the current "laster" version.
Related to #8206