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

Improve docs #15

Merged
merged 2 commits into from
May 31, 2024
Merged

Improve docs #15

merged 2 commits into from
May 31, 2024

Conversation

ilyaZar
Copy link
Contributor

@ilyaZar ilyaZar commented Mar 29, 2023

Two things:

  • fix typos/unclear formulation
  • I think (as a user, that was the case for me) the README of the package could be a bit more encouraging; I only realized the usefullness of gargoyle when reading the shiny production grade book, but less so from the package description; hence I'd add a more motivational/encouraging README

- fix some typos
- change `listen` to `watch`
- What the heck: change control flow to 'controlled flow' and make reference to reactivity as this is what it is about

- For whom: use the phrasing from  "engineering production grade shiny app" because this is formulation is more encouraging for the user

- Trade-off: explain why you believe it is for the best to use gargoyle when working on larger projects (motivation)
@ColinFay ColinFay merged commit d15eaf1 into ColinFay:master May 31, 2024
@ColinFay
Copy link
Owner

Thanks!

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.

None yet

2 participants