Skip to content

Port Xamarin documentation about user notifications to .NET.#66

Merged
davidbritch merged 13 commits intodotnet:mainfrom
rolfbjarne:user-notifications
Apr 14, 2025
Merged

Port Xamarin documentation about user notifications to .NET.#66
davidbritch merged 13 commits intodotnet:mainfrom
rolfbjarne:user-notifications

Conversation

@rolfbjarne
Copy link
Copy Markdown
Member

@rolfbjarne rolfbjarne commented Dec 12, 2024

Copy the Xamarin documentation about user notifications, and modify/update/verify it for .NET.

Accompanying sample project: dotnet/macios-samples#3
Templates in progress: dotnet/macios#21886


Internal previews

📄 File 🔗 Preview link
docs/ios/app-fundamentals/user-notifications.md docs/ios/app-fundamentals/user-notifications

🚧 Work in progress, no need to review yet 🚧

* Copy existing documentation about notifications to .NET.
* Update the actual text a bit to avoid sounding old (phrasing such as "new in
  iOS 10..." was removed for instance).
* Removed instructions for VSMac, added instructions for VSCode.
* Misc cleanup.
@rolfbjarne
Copy link
Copy Markdown
Member Author

rolfbjarne commented Jan 2, 2025

Marking as do-not-merge because the app extension template mentioned here hasn't been released yet.

@rolfbjarne rolfbjarne requested a review from davidbritch January 2, 2025 14:04
Copy link
Copy Markdown

@davidbritch davidbritch left a comment

Choose a reason for hiding this comment

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

I haven't commented on every occurrence of an issue, but there are essentially three issues:

  1. You need to add user-notifications to the TOC (and index.md if you decide to keep it). Everything has to go in the TOC.
  2. File/folder names should be italicised rather than treated as code.
  3. All images need left-aligning with their parent numbered list.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Is this file needed? Generally we don't bother with index.md files anymore unless they add some unique information that isn't present elsewhere.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Are there going to be more docs about user notifications? If so, it justifies having a user-notifications folder. If not, you can remove the folder and just have app-fundamentals/user-notifications.md.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

On which platforms?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

You always need periods on the ends of bullets to make screen readers pause.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Do I need the period when each bullet point is just a link? For the "See also" section for instance: https://github.com/dotnet/docs-mobile/pull/66/files#diff-ff5d095438ec9514bb6fa8758bec8032bc3ad1b0a9c33b56237307ed7c1561b1R737-R743

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Periods on ends of bullets.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

File/folder names should be italicised rather than treated as code.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

File/folder names should be italicised rather than treated as code.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

All these images need indenting so they are left aligned with the numbered list.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Indent.

@rolfbjarne rolfbjarne requested a review from davidbritch January 7, 2025 11:23
@rolfbjarne rolfbjarne removed the do-not-merge Do not merge label Apr 8, 2025
@rolfbjarne
Copy link
Copy Markdown
Member Author

@davidbritch this can be merged now.

@davidbritch davidbritch merged commit 39ee035 into dotnet:main Apr 14, 2025
3 checks passed
@davidbritch davidbritch deleted the user-notifications branch April 14, 2025 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants