Skip to content

Conversation

@gewarren
Copy link
Contributor

@gewarren gewarren commented Jan 18, 2023

Contributes to #33349

This doesn't contain changes to the L2 header since that happens in a different repo.

Previews:

Copy link
Contributor

@tdykstra tdykstra left a comment

Choose a reason for hiding this comment

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

If you're in one of these TOCs how do you see what others are available, and how do you get to one of the others? If, for example, you're on the Fundamentals TOC, how do you see that there's a separate Tools and diagnostics TOC and how do you get to it? Or the reverse - how do you go from Tools and diagnostics to Fundamentals?

@gewarren
Copy link
Contributor Author

gewarren commented Jan 19, 2023

If you're in one of these TOCs how do you see what others are available, and how do you get to one of the others? If, for example, you're on the Fundamentals TOC, how do you see that there's a separate Tools and diagnostics TOC and how do you get to it? Or the reverse - how do you go from Tools and diagnostics to Fundamentals?

This would be either from the new proposed L2 header menu ("Features") or by following the breadcrumb up the chain to ".NET" and the .NET hub page. Which will need to be updated to list each of the new proposed TOCs if we decide to move forward with this.

One thing we discussed in the meeting on Tuesday is that if you land on some "specialized" article via search, for example, package validation (which is in the tools & diagnostics TOC), then you don't need to see the .NET fundamentals TOC because you're likely already well-versed in .NET.

@BillWagner
Copy link
Member

I like the strategy here a lot. The .NET ecosystem is quite large, and we need to have a solid organization for all the content to make it navigable for all readers.

This places a lot more emphasis on the L2 header for navigation, along with the breadcrumb header for knowledge of place. That's a good way forward, but we may need to consider how we raise more awareness of those elements.

On the specific breakdown:

  • I wonder if performance should move to "Advanced programming techniques".
  • I'd like to have more visibility in the data section for other data storage models. In particular, we should link to the various .NET toolkits for Azure storage (tables, CosmosDB, etc).
  • Should the JSON serialization articles be under data access? Or should XML data access be under Serialization in the Fundamentals section? (They seem related, and now they are separated).

As we iron these out, this is a great direction!

@tdykstra
Copy link
Contributor

This places a lot more emphasis on the L2 header for navigation, along with the breadcrumb header for knowledge of place. That's a good way forward, but we may need to consider how we raise more awareness of those elements.

Maybe at the end of each TOC have a node that says something like "More..." and links to a page that shows screenshots of the L2 and breadcrumbs being used. That way there wouldn't need to be any TOC context shifting.

  • I wonder if performance should move to "Advanced programming techniques".

+1

  • I'd like to have more visibility in the data section for other data storage models. In particular, we should link to the various .NET toolkits for Azure storage (tables, CosmosDB, etc).

+1

  • Should the JSON serialization articles be under data access? Or should XML data access be under Serialization in the Fundamentals section? (They seem related, and now they are separated).

XML data access seems to me to fit best in the Data access section, but serialization doesn't. I would keep Serialization in Fundamentals. We can cross-link between the XML serialization and XML data access articles.

@gewarren
Copy link
Contributor Author

Okay, I moved memory management articles to the advanced programming TOC and left security in its own TOC. I moved the memory/span types and SIMD types articles to fundamental coding components in the main TOC where we talk about other categories of types.

@gewarren gewarren marked this pull request as ready for review January 21, 2023 01:29
Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

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

This really looks great @gewarren

I'm happy with the changes you made. I'm ready to :shipit:.

@gewarren gewarren merged commit 6ab5d2b into dotnet:main Jan 23, 2023
@gewarren gewarren deleted the toc-split branch January 23, 2023 18:16
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.

4 participants