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

Refreshed look of pkg site and readme #194

Merged
merged 5 commits into from
Jun 30, 2020
Merged

Refreshed look of pkg site and readme #194

merged 5 commits into from
Jun 30, 2020

Conversation

dokato
Copy link
Contributor

@dokato dokato commented Jun 20, 2020

Refreshed readme

A few things have been done:

  • as suggested by @filipstachura highlighter infor removed from readme remove highlither #192
  • readme simplified a little
  • Appsilon logo added at the end
  • added example that actually easily works with shiny.semantic this time
  • rerendered docs website

@dokato dokato requested a review from olgamie June 20, 2020 11:23
Copy link
Contributor

@olgamie olgamie left a comment

Choose a reason for hiding this comment

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

Looks good 👍 I have few minor comments.

README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated
Firstly, you will have to invoke `shinyUI()` with `semanticPage()` instead of standard Shiny UI definitions like e.g. `fluidPage()`. From now on forward all components can ba annotated with [Semantic UI][semantic_website_url] specific CSS classes and also you will be able to use [shiny.semantic components](`r params$demo_url`).
-------------

Firstly, you will have to invoke `shinyUI()` with `semanticPage()` instead of standard Shiny UI definitions like e.g. `fluidPage()`. From now on, all components can be annotated with [Fomantic UI][fomantic_website_url] specific CSS classes and also you will be able to use [shiny.semantic components](`r params$demo_url`).
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add a screenshot of the app that renders the example?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is very simple example that looks basically like this:
Screenshot 2020-06-25 at 10 06 01
Are you sure we want to add it?


Check out also our dashboard examples made with **shiny.semantic**
library:

1. [Churn analytics](https://demo.appsilon.ai/churn)
2. [Fraud detection](https://demo.appsilon.ai/frauds)
| [Churn analytics](https://demo.appsilon.ai/churn) | [Fraud detection](https://demo.appsilon.ai/frauds) |
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally we have this in a for that Filip mentioned on the call so app on the left and code on the right with some comments: https://shiny.rstudio.com/ (see Here is a Shiny app)
but in the meantime can we provide links to apps source code?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it can be done like this runApp("examples/calendar/", display.mode = "showcase")

but currently it does not look the greatest:
Screenshot 2020-06-25 at 10 17 42

probably fomantic - boostrap incompatibility - requires detailed investigation... I added an issue for that: #202

@@ -174,7 +195,7 @@ server <- shinyServer(function(input, output) {
shinyApp(ui = ui(), server = server)
```

How to contribute? {.darkslide}
How to contribute?
Copy link
Contributor

Choose a reason for hiding this comment

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

i suggest to make this more user friendly :) I can take care of that and will add a PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

would be great, I think styleguide is needed for sure, anything else?

@olgamie
Copy link
Contributor

olgamie commented Jun 22, 2020

One more thing, i think we should mention in the documentation also examples in the example folder.

Copy link
Contributor

@olgamie olgamie left a comment

Choose a reason for hiding this comment

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

One more thing let's put See *examples* with code in the examples folder as a first-line in the section with components examples, not the last one. After this LGTM

@dokato dokato merged commit 3616f04 into develop Jun 30, 2020
@dokato dokato deleted the readmeupt branch June 30, 2020 08:20
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.

2 participants