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

chore: improves dashboard docs #3098

Merged
merged 1 commit into from
Jan 16, 2025
Merged

chore: improves dashboard docs #3098

merged 1 commit into from
Jan 16, 2025

Conversation

fpauer
Copy link
Contributor

@fpauer fpauer commented Jan 7, 2025

Overview

  • Refactor Dashboard documentation pages to follow same pattern as other links in the components section
  • Update dashboard with latest changes
  • Add live example for the dashboard component
  • Add example with Assistant enabled

Verifying Changes

DashboardDocs_Update_smaller.mov

Scene Composer

For scene-composer package changes specifically, you can preview the component in the published storybook artifact. To do this, wait for the Publish Storybook action to complete below.

  • Click on the workflow details
  • Select the Summary item on the left
  • Download the zip file

To run the storybook build locally, you need a local static web server:

npm install -g httpserver
cd <Extracted Zip Directory>
httpserver

Then open the website http://localhost:8080 to run the doc site.

Legal

This project is available under the Apache 2.0 License.

@fpauer fpauer added the documentation Improvements or additions to documentation label Jan 7, 2025
@fpauer fpauer changed the base branch from main to rc January 7, 2025 00:00
jmbuss
jmbuss previously approved these changes Jan 14, 2025
@jmbuss jmbuss dismissed their stale review January 14, 2025 18:52

The merge-base changed after approval.

@fpauer fpauer requested a review from jmbuss January 15, 2025 21:25
@fpauer fpauer force-pushed the chore/dashboard-docs branch from 3cd2370 to 99e8211 Compare January 15, 2025 21:38
@jmbuss jmbuss requested review from jmbuss and removed request for jmbuss January 15, 2025 21:53
jmbuss
jmbuss previously approved these changes Jan 15, 2025
@jmbuss jmbuss enabled auto-merge (rebase) January 15, 2025 22:00
@jmbuss jmbuss dismissed their stale review January 15, 2025 22:14

The merge-base changed after approval.

@fpauer fpauer force-pushed the chore/dashboard-docs branch from 4a4e67c to a1bad6f Compare January 15, 2025 22:48
@fpauer fpauer force-pushed the chore/dashboard-docs branch from a1bad6f to 88ee658 Compare January 15, 2025 23:26
@fpauer fpauer requested a review from jmbuss January 16, 2025 18:53
auto-merge was automatically disabled January 16, 2025 18:58

Rebase failed

@fpauer fpauer merged commit af93e20 into rc Jan 16, 2025
46 checks passed
@fpauer fpauer deleted the chore/dashboard-docs branch January 16, 2025 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants