Align Documentation with Implementation #32
Description
Priority: P3 - Nice to have
Tier: 4 - Polish
Effort: Medium (6-8 hours)
Already In Codebase
- Docs currently describe several features that are not yet implemented (or differ from current implementation), including:
- Hooks (not generated yet)
- Converter types (
IDynamoConverter<T>not in runtime yet) - Some method signatures described for
[DynamoField(ToMethod/FromMethod)]do not match the current generator behavior
- README lists features like hooks/converters/diagnostics that are partially aspirational relative to the current code.
Goal
Align documentation with the actual implementation so the published docs and README do not promise features that do not exist yet.
Scope
- Update README quick start and feature list to match current reality.
- Update docs pages under
docs/usage/to clearly indicate:- what is implemented now
- what is planned (with links to issues)
- Ensure any code samples compile against the current API surface.
Acceptance criteria
- Examples in docs compile as written.
- No aspirational features are presented as shipping.
- Links to tracking issues exist for not-yet-implemented features.