Skip to content
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 actor serialization documentation #4370

Open
WhitWaldo opened this issue Oct 7, 2024 · 1 comment
Open

Update actor serialization documentation #4370

WhitWaldo opened this issue Oct 7, 2024 · 1 comment
Labels
content/missing-information More information requested or needed

Comments

@WhitWaldo
Copy link
Contributor

What content needs to be created or modified?
While the documentation at https://github.com/dapr/dotnet-sdk/blob/master/daprdocs/content/en/dotnet-sdk-docs/dotnet-actors/dotnet-actors-serialization.md accurately describes the strong-typed version of the actor serialization, it could do more to indicate that JSON serialization is used actors referenced via the weakly-typed factory.

Where should the new material be placed?
Because of the length of the current document, it might make sense to write a separate document for the JSON serialization in actors and then still another that has some sort of flow chart and description that gives better guidance as to when a developer should opt for either approach.

The associated pull request from dapr/dapr, dapr/components-contrib, or other Dapr code repos
Not necessarily applicable, though the dotnet-sdk Actor DI registration methods could be improved on to reflect the updated documentation in the XML comments to provide richer in-place documentation.

Additional context
Would close the following issues:
dapr/dotnet-sdk#1050
dapr/dotnet-sdk#1138
dapr/dotnet-sdk#891

@WhitWaldo WhitWaldo added the content/missing-information More information requested or needed label Oct 7, 2024
@WhitWaldo
Copy link
Contributor Author

I don't mind tackling this, but I don't know if I'll be able to get to it before the 1.15 release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content/missing-information More information requested or needed
Projects
None yet
Development

No branches or pull requests

1 participant