Conversation
eeberhard
force-pushed
the
docs/studio-v5
branch
from
7513ecc to
32fafe2
Compare
|
@SprGrf @domire8 I very quickly started on this topic just to get some nomenclature and structure in place. It will need new screenshots and new text, which I will be unlikely to finish in the next days, but it should provide enough context on what this will look like to support the other updated examples. |
eeberhard
force-pushed
the
docs/studio-v5
branch
from
32fafe2 to
4bfafac
Compare
docs/core_versioned_docs/version-v4/studio/profiles-and-scopes.md
Outdated
Show resolved
Hide resolved
rrosa24
left a comment
rrosa24
left a comment
There was a problem hiding this comment.
Really nice work here- excited to have this page :)
|
Thanks for the reviews! |
| The default landing page when opening AICA Studio is the application manager and editor. It can also be accessed by | ||
| clicking the "Editor" tab in the top navbar. | ||
| clicking the "Editor" link in the top navbar. |
There was a problem hiding this comment.
I find the sentence a bit confusing. Which one of the aforementioned two can be accessed by the Editor link? Also should the Editor be in bold?
|
|
||
| On the left of the screen is the YAML code representation of the application, which is how applications are stored and | ||
| parsed. On the right are visualization tools, including the unique application graph editor and the 3D scene viewer. | ||
| The editor features two panels on the left and right side of a main view, with a mini-view in the bottom left. Next to |
There was a problem hiding this comment.
To match the previous I imagine
| The editor features two panels on the left and right side of a main view, with a mini-view in the bottom left. Next to | |
| The editor features two panels on the left and right side of a main view, with a mini-view on the bottom left. Next to |
|
|
||
| Exit back to the application manager screen using the X button on the top left. It will prompt to save or discard | ||
| unsaved changes. Running applications will be stopped when closing the application. | ||
| The main view can also be switched to render the 3D scene of the application by clicking on the mini-view in the bottom |
There was a problem hiding this comment.
same as the previous, if you decide to change it
| The Add Component sub-tab is used to add elements to the application. | ||
|
|
||
| <div style={{display: 'flex', justifyContent: 'center', paddingBottom: '1rem'}}> | ||
| <img src={AddComponentMenu} alt="aica-studio-add-component" width="600"/> |
There was a problem hiding this comment.
Styling suggestion, just to match a bit more with the full window screenshots, I think we have used it elsewhere
| <img src={AddComponentMenu} alt="aica-studio-add-component" width="600"/> | |
| <img src={AddComponentMenu} alt="aica-studio-add-component" width="600" style={{ borderRadius: "8px" }}/> |
| ## Live Data | ||
|
|
||
| While an application is running, view the data flowing on signals and other background topics on the ROS 2 network. | ||
| Use the Choose Topic selector to change the topic to visualize. Selecting a signal edge in the graph view while the |
There was a problem hiding this comment.
Highlight Choose Topic somehow?
|
|
||
| ## Profiles | ||
|
|
||
| When using AICA Launcher as the system administrator, AICA Studio will show a "Super Admin" landing page to select or |
There was a problem hiding this comment.
How do I do that? And how do I use it as a normal user with a profile?
| @@ -0,0 +1,119 @@ | |||
| --- | |||
There was a problem hiding this comment.
General comment on the page; I feel it does not belong here. We move from casually touring studio and exploring the interface to security and authentication concepts that are quite heavier. I also think it's something that I would instinctively look for in the Getting Started section where it is now.
There was a problem hiding this comment.
MDX is markdown with JSX support, where JSX is javascript with XML support, specifically intended for HTML. In short, mdx allows markdown files to contain things like:
<div style={{display: 'flex', justifyContent: 'center', paddingBottom: '1rem'}}>
<img src={AddComponentMenu} alt="aica-studio-add-component" width="600"/>
</div>Docusaurus interprets mdx even if the file is marked as .md, so changing the extension is mostly convenient as a filetype hint for editors to not complain about syntax.
4 participants
Description
This PR solves the issue by reworking the v5 Tour of AICA Studio with new text, screenshots and pages for the various features.
I also migrated the general "users and authentication" page to be a version specific page, since nomenclature and behavior changed between v4 and v5.
Review guidelines
Estimated Time of Review: x minutes
Checklist before merging: