-
Notifications
You must be signed in to change notification settings - Fork 200
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
Merge essentials articles into single sensors article #90
Merge essentials articles into single sensors article #90
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.
Only minor comments.
docs/TOC.yml
Outdated
@@ -26,3 +26,8 @@ | |||
items: | |||
- name: Customize controls | |||
href: user-interface/handlers/customize.md | |||
- name: Device features |
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 root node should be Platform integration, followed by an Essentials node, then Sensors.
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.
Ditto for the folder structure in the repo: docs/platform-integration/essentials/
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.
I'll follow up with a new PR to move all the files. With the TOC though, should we call out essentials as a section? What benefic does it provide to do
Device features > Essentials > Sensors over
Device features > Sensors
The TOC doesn't need to logically follow the repo folder structure. I know the product will evolve with how essentials is presented to the developer, but to me, it doesn't make sense to call out essentials anymore. It's not a library or a product, you may need some config, but it's just using .NET MAUI to access to device features, essential or not. We can play with it.
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.
There are two issues here. The first is calling it Device features. Essentials includes functionality that isn't a device feature (e.g. main thread access, file APIs, web auth etc.). Hence the original product name - it was the essential functionality missing from Xamarin.Forms, and other Xamarin platforms. It's still going to publicly be referred to as Essentials over the first year of MAUI.
The second issue is that we specifically want a root TOC node of Platform integration, with Essentials under it, because Essentials is but one approach to platform integration. There'll be a lot more content under Platform integration. If we don't have the Essentials node under Platform integration it'll get very messy finding things (there'll be ~100 docs under platform integration at GA).
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.
I'll merge to keep you moving, but we definitely want Platform integration > Essentials > Sensors, and the same folder structure in the repo.
Internal preview link
@davidbritch
Contributes to #16