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

🚀: Simplify Readme and Quickstart further #119

Closed
5 of 7 tasks
Nek-12 opened this issue Dec 14, 2024 · 0 comments · Fixed by #123
Closed
5 of 7 tasks

🚀: Simplify Readme and Quickstart further #119

Nek-12 opened this issue Dec 14, 2024 · 0 comments · Fixed by #123
Assignees

Comments

@Nek-12
Copy link
Member

Nek-12 commented Dec 14, 2024

Description

Based on feedback, the library is still hard to get started with. The amount of features is scary, so we can reduce this initial friction by simplifying things:

  • Move the diagram into a collapsible section or into the plugin doc.
  • Move the JDK configuration somewhere into "Troubleshooting" doc
  • Simplify readme and avoid showcasing all of the stuff at once, or add a much simpler example on top
  • Make quickstart dependency section collapsed
  • Move state management / contract details into a separate state management doc?
  • Explain Pipeline context typealias later, do not mention it during container generation
  • Add "Complete implementation" section to the end of quickstart (optionally) to see the result
@Nek-12 Nek-12 added the triage Needs triaging label Dec 14, 2024
@Nek-12 Nek-12 self-assigned this Dec 14, 2024
@Nek-12 Nek-12 removed the triage Needs triaging label Dec 14, 2024
@Nek-12 Nek-12 linked a pull request Dec 23, 2024 that will close this issue
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 a pull request may close this issue.

1 participant