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

docs: Updating examples for consistency #378

Merged
merged 5 commits into from
Apr 2, 2024

Conversation

mofojed
Copy link
Member

@mofojed mofojed commented Mar 21, 2024

  • Adding some more basic examples, adding only one concept with each example
    • Start with a couple one-liners, show core concepts one at a time first
  • Update all import deephaven.ui as ui to from deephaven import ui
  • Clean up a lot of examples
  • Fixes deephaven.ui examples and docs - provide consistency and best practices in examples #341
  • Next I think we need a Components section that just details each component. Like copy over what we have with DESIGN.md, add an example. Would only be the things that have been implemented, while DESIGN.md has the full spec.
    • There are a few links to React Spectrum components, when instead we should just link our own Components section

mofojed added 3 commits March 20, 2024 13:55
- Adding some more basic examples, adding only one concept with each example
  - Start with a couple one-liners
- Clean up state, need to start cleaning up after "Using State"
- Update all import deephaven.ui to from deephaven import ui
- Have some more basic examples to start
- Clean up a lot of examples
- Fixes deephaven#341
- Next I think we _need_ a Components section that just details each component. Like copy over what we have with DESIGN.md, add an example. Would only be the things that have been implemented, while DESIGN.md has the full spec.
  - There are a few links to React Spectrum components, when instead we should just link our own Components section
@mofojed mofojed requested a review from dsmmcken March 21, 2024 13:40
@mofojed mofojed self-assigned this Mar 21, 2024
@mofojed mofojed changed the title docs: Updating examples docs: Updating examples for consistency Mar 21, 2024
@dsmmcken
Copy link
Contributor

Next I think we need a Components section that just details each component. Like copy over what we have with DESIGN.md, add an example. Would only be the things that have been implemented, while DESIGN.md has the full spec.
There are a few links to React Spectrum components, when instead we should just link our own Components section

Let's start a docs folder that will eventually become the official docs.

plugins > ui > docs > index.md introduction/overview
plugins > ui > docs > components > picker.md etc
plugins > ui > docs > hooks

count, set_count = ui.use_state(0)

def handle_press():
set_count(count + 1)
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe the classic increment/decrement example would fit better here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed it up a bit, let me know what you think.

Copy link
Contributor

@dsmmcken dsmmcken left a comment

Choose a reason for hiding this comment

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

Most notably, all examples will only appear within one panel in the UI, the ui.table functionality (allowing interactivity and customization of displayed tables), and ability to use other plugins (such as deephaven.plot.express) is not yet implemented.

That could be updated too.

plugins/ui/examples/README.md Outdated Show resolved Hide resolved
plugins/ui/examples/README.md Outdated Show resolved Hide resolved
plugins/ui/examples/README.md Show resolved Hide resolved
plugins/ui/examples/README.md Outdated Show resolved Hide resolved
plugins/ui/examples/README.md Outdated Show resolved Hide resolved
plugins/ui/examples/README.md Outdated Show resolved Hide resolved
plugins/ui/examples/README.md Outdated Show resolved Hide resolved
plugins/ui/examples/README.md Outdated Show resolved Hide resolved
plugins/ui/examples/README.md Outdated Show resolved Hide resolved
plugins/ui/examples/README.md Outdated Show resolved Hide resolved
@mofojed mofojed merged commit 6292b3a into deephaven:main Apr 2, 2024
12 checks passed
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.

deephaven.ui examples and docs - provide consistency and best practices in examples
3 participants