akkadotnet / akkadotnet/Akka.Serialization.MessagePack

Update Readme and Sample hocon for new settings

Open
#37 1 comment 0 reactions 0 assignees View on GitHub
docs help wanted
Dominant language
C#
Stars
15
Forks
8
PR merge metrics
No merged PRs in 30d

Description

We don't have documentation around how to use `BackwardsCompatibleSurrogatedFormatter`, let alone in a way useful to users (If they REALLY want to for some reason, they'll probably have to override a serializerID or similar.

Also we should provide some docs and explanation around:

- LZ4 Settings
- `converters` vs `converters-override`
- May be worth providing an example of how to 'override' TypelessFormatter while safely respecting Akka surrogates, etc.

Contributor guide

Open the contributing guide

Research direction

Start with the repository README and sample HOCON configuration mentioned in the issue, then inspect the existing serialization settings documentation. Done means documenting BackwardsCompatibleSurrogatedFormatter, LZ4 settings, the difference between converters and converters-override, and a safe TypelessFormatter override example that respects Akka surrogates.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.