feat: Update documentation for .NET 9 and MAUI #957
Conversation
- Initial Setups Added - Used `ParseClient.Instance` for simplicity's sake.
Updated the instructions on Parse RegisterSubClass, indicating the best order to use for Init. - Removed info on Progress reporting (WIP..) More changes on comments.
|
Pretty happy with the docs as of now. |
Co-authored-by: Manuel <[email protected]>
Co-authored-by: Manuel <[email protected]>
|
Thanks for this PR; It takes a while to review this, because of its size. I've completed the files.md and analytics.md files. Just a quick feedback for future edits: I often find two whitespaces between sentences in your edits, not sure if that's your writing style or a technical auto-format issue. I also see a lot of cursive and bold usage, I'm trimming that down as well. We do not mention unrelated 3rd parties or company names (even if they are popular) in doc examples. I'm working my way through it, thanks for your patience. |
|
@YBTopaz8 Have some of the docs changes been written by AI? The changes look quite strange at some places, and there are many changes that do not add much value, they are mere rewordings, making this a lot of unnecessary work to review. Also the formatting looks quite strange in many places. |
|
Besides visual studio code's, Auto complete, I'd say no. AI can't help since the syntax is now quite different. Are there any inconsistencies you'd like for me to check? I'll rapidly fix them as I do have some time if it helps |
|
Interesting. No worries, I'll review this, you have had a lot of work already with the SDK refactor. Just for future PRs I'd like to point out that a change like this adds little value but it makes reviewing quite time consuming. And there are many of these. I understand that there may be semantic preferences, but if we go after that we'd be constantly rewriting the docs as everyone has a slightly different preference. We generally pursue a "least changes PR policy" - only change what's necessary to speed up review time. - Storing data on Parse is built around the `ParseObject`. Each `ParseObject` contains key-value pairs of JSON-compatible data. This data is schemaless, which means that you don't need to specify ahead of time what keys exist on each `ParseObject`. You simply set whatever key-value pairs you want, and our backend will store it.
+ Data storage in Parse is centered around the `ParseObject`. Each `ParseObject` holds key-value pairs of JSON-compatible data. This data is schemaless, meaning you don't predefine keys. You set key-value pairs, and the backend stores them. |
|
Very very well noted. I'll be ensuring the next rounds are better. Still learning how things are structured doc-wise :) (And thank you for your patience!) |
There was a problem hiding this comment.
Could you please revert any unnecessary wording changes in these files:
- _includes/dotnet/objects.md
- _includes/dotnet/queries.md
- _includes/dotnet/roles.md
- _includes/dotnet/users.md
There are also several formatting errors such as lists with spaces before the bullet point item, or double space between sentences. If you revert the wording, they should largely disappear anyway. There may be parts where you feel that a rewording or restructuring of the text makes sense, but they should be justifiable, beyond semantic preference. Also, if you feel that introducing new headings makes the docs easier to navigate, please feel free to add/keep them; I see you have added some.
The other files are good, apart from a few minor formatting issues that I'll correct now.
| // IMPORTANT: Change "parseXAMARIN/.NET MAUIpushsample" to match your namespace. | ||
| [Application(Name = "parseXAMARIN/.NET MAUIpushsample.ParseApplication")] |
There was a problem hiding this comment.
Is this really a recommendable app name, with spaces and special chars like dot and slash? Looks like you did a find/replace here. Maybe keep it simple:
| // IMPORTANT: Change "parseXAMARIN/.NET MAUIpushsample" to match your namespace. | |
| [Application(Name = "parseXAMARIN/.NET MAUIpushsample.ParseApplication")] | |
| // Important: change "parsepushexample" to match your namespace | |
| [Application(Name = "parsepushexample.ParseApplication")] |
There was a problem hiding this comment.
Underscores or no spaces!
My fault here, for not checking that one after doing a quick replacement of Xamarin to MAUI.
On that!
| platform: dotnet/dotnet MAUI | ||
| language: csharp | ||
| display_platform: .NET MAUI |
There was a problem hiding this comment.
What effect do these changes have? I'm not sure how the docs are compiled and how these params are used, but to make sure we understand why we're changing these.
There was a problem hiding this comment.
The aim is to lay more emphasis on the fact that Maui is supported too. As Maui is quite new and not very "known", it's really to put it on a spotlight.
Otherwise, it can be removed.
There was a problem hiding this comment.
But what do these parameters do? What are the effects if we change them? I'm unsure but they don't seem to be just text but be part of a logic.
There was a problem hiding this comment.
Text that affects this.
Title will change the title in the browser tab, the rest we can revert
Though I'd argue setting display_platform as .NET/MAUI or something will be good. Else, it's still fine.
|
All Good |
This PR comprehensively updates the Parse .NET SDK documentation to align with the recent .NET 9 and MAUI support. These changes are made in the spirit of fostering an open, welcoming, and collaborative community, as outlined in our Contributor Covenant Code of Conduct.
Changes include:
ParseClient.Instanceand current APIs.