Skip to content

Improve Dry Struct docs - #321

Open
katafrakt wants to merge 3 commits into
mainfrom
dry-struct-docs
Open

Improve Dry Struct docs#321
katafrakt wants to merge 3 commits into
mainfrom
dry-struct-docs

Conversation

@katafrakt

Copy link
Copy Markdown
Contributor

This provides a bunch of improvements for Dry Struct docs

  • Virtus had its prime time a decade ago. Positioning Dry Struct as "virtus-like" might not be very informative for younger developers or the ones who missed Virtus.
  • Value had IMO too prominent place in the index page, for a deprecated feature. I moved it into a new "deprecated features" page.
  • Add "Extensions" page for super_diff extension
  • Add information about optional nested structs
  • Fix how we spell names of Dry gems and some additional language improvements

Virtus is discontinued and Value is deprecated. We should not give them
such prominent place on the index page.
---

`dry-struct` is a gem built on top of `dry-types` which provides virtus-like DSL for defining typed struct classes.
Dry Struct is a gem built on top of [Dry Types](//org_guide/dry/dry-types) which provides a DSL for defining typed struct classes. It allows building immutable data structures with type safety and coersions, making sure that the data is in the shape you want it to be.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I generally think we could still have more "why?" here, but currently I'm not sure how.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I just saw @cllns's comment in dry-rb/dry-struct#203 about un-deprecating Value, so not sure how to go about this. Perhaps it would be good to make a decision in either way.

- Deprecated features page
- Extensions page
- Add information about optional nested structs
@github-actions

Copy link
Copy Markdown
Contributor

❇️ Deploy preview: https://pr-321--hanakai.netlify.app

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.

1 participant