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.

Sign up for GitHub

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

Jump to bottom

README.md improvement ideas for easier onboarding #74

Open
l-laura opened this issue Feb 1, 2022 · 1 comment
Open

README.md improvement ideas for easier onboarding #74

l-laura opened this issue Feb 1, 2022 · 1 comment
Labels
Docs 📜 Improvements or additions to documentation

Comments

@l-laura
Copy link

l-laura commented Feb 1, 2022 •
edited
Loading

  1. Start docs with a visualization of the artifacts in a typical project using zswag (zserio sources, generated zserio, zswag-gen and the OpenAPI spec, implementations of client/service). Ideally with a super-short overview of how the workflow steps utilize different parts of zswag.

  2. Move the component UML further down - it is informative, but the details are not important for all users and the image looks scary for the uninvolved.

  3. Rename "Server Component" section to "Python Server" and add a stub section "C++ Server" noting that it does not exist.
@l-laura l-laura added the Docs 📜 Improvements or additions to documentation label Feb 1, 2022
@fklebert
Copy link
Contributor

fklebert commented Feb 1, 2022

I especially like the first point!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs 📜 Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@fklebert @l-laura