Skip to content

Commit

Permalink
[doc] Update how-tos documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Jessy Mallet <[email protected]>
  • Loading branch information
jessymallet committed Apr 24, 2024
1 parent 2a647f1 commit dd43544
Show file tree
Hide file tree
Showing 44 changed files with 675 additions and 683 deletions.
2 changes: 1 addition & 1 deletion doc/content/modules/user-manual/pages/faq/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To explore the supported {sysmlv2} views, refer to the xref:user-manual:features
.How do I create a new model?
[%collapsible]
====
To create a new model, refer to the xref:user-manual:hands-on/how-tos/create-model.adoc[[Create a new model] section in the user manual.
To create a new model, refer to the xref:user-manual:hands-on/how-tos/model-management.adoc#create-model[[Create a new model] section in the user manual.
====

.How do I import and export models?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
There are various solutions available for collaborating with {product}.
Explore different collaboration methods to enhance your teamwork and communication within {product}.

* *Share Projects, Models, Diagrams*: Collaborating in {product} is a breeze with the ability to xref:hands-on/how-tos/share-project.adoc[share projects], models, and xref:hands-on/how-tos/share-representation.adoc[diagrams] using straightforward methods.
* *Share Projects, Models, Diagrams*: Collaborating in {product} is a breeze with the ability to xref:hands-on/how-tos/project-management.adoc#share-project[share projects], models, and xref:hands-on/how-tos/representation-operations.adoc#share-representation[diagrams] using straightforward methods.
Sharing projects and models is as simple as providing a link, similar to the process of sharing diagrams.
* xref:features/interoperability.adoc[*Exchange* Projects or Models].
6 changes: 3 additions & 3 deletions doc/content/modules/user-manual/pages/features/editor.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ include::user-manual:partial$homepage-action.adoc[leveloffset=+3]
[#project-actions]
==== Projects Actions

Access project-level actions like _xref:hands-on/how-tos/rename-project.adoc[rename]_, _xref:hands-on/how-tos/download-project.adoc[download]_, access project _xref:hands-on/how-tos/project-settings.adoc[settings]_, _xref:hands-on/how-tos/delete-project.adoc[delete]_.
Access project-level actions like _xref:hands-on/how-tos/project-management.adoc#rename-project[rename]_, _xref:hands-on/how-tos/project-management.adoc#download-project[download]_, access project _xref:hands-on/how-tos/project-management.adoc#project-settings[settings]_, _xref:hands-on/how-tos/project-management.adoc#delete-project[delete]_.

image::editor-projectActions.png[{editor} Project Actions]

Expand All @@ -56,7 +56,7 @@ NOTE: The left sidebar provides information related to the project.
a|image::editor-left-sidebar-explorer.png[{editor} Left sidebar Explorer] a|image::editor-left-sidebar-explorer.png[{editor} Left sidebar Validation]
|===

xref:hands-on/how-tos/switch-left-sidebar.adoc[Explore the left sidebar...]
xref:hands-on/how-tos/user-interface-navigation.adoc#switch-left-sidebar[Explore the left sidebar...]

=== Editor

Expand All @@ -80,4 +80,4 @@ NOTE: The content of the right sidebar depends on the current selection.
a|image::editor-right-sidebar-details.png[{editor} Right sidebar Details] a|image::editor-right-sidebar-representations.png[{editor} Right sidebar Representations] a|image::editor-right-sidebar-related-elements.png[{editor} Right sidebar Related Elements]
|===

xref:hands-on/how-tos/switch-right-sidebar.adoc[Explore the right sidebar...]
xref:hands-on/how-tos/user-interface-navigation.adoc#switch-right-sidebar[Explore the right sidebar...]
34 changes: 17 additions & 17 deletions doc/content/modules/user-manual/pages/features/explorer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ image::editor-left-sidebar-explorer.png[{editor} Left sidebar Explorer]

At the top of the {explorer}, a toolbar provides quick access to essential actions:

* xref:hands-on/how-tos/create-model.adoc[Add a Model]: Enables the creation of a new model within the project.
* xref:hands-on/how-tos/upload-model.adoc[Upload a Model]: Allows users to upload and integrate an external model into the project.
* xref:hands-on/how-tos/sync-editor.adoc[Synchronize Editor] with Explorer: Ensures alignment between the explorer view and the editor, providing a seamless and up-to-date navigation experience.
* xref:hands-on/how-tos/model-management.adoc#create-model[Add a Model]: Enables the creation of a new model within the project.
* xref:hands-on/how-tos/model-management.adoc#upload-model[Upload a Model]: Allows users to upload and integrate an external model into the project.
* xref:hands-on/how-tos/explorer.adoc#sync-editor[Synchronize Editor] with Explorer: Ensures alignment between the explorer view and the editor, providing a seamless and up-to-date navigation experience.

== Selection

Expand All @@ -43,22 +43,22 @@ The *{explorer-menu}* (three-dots More menu) offers a set of relevant actions de
This menu provides functionalities based on the selected item:

* For Models (Root Elements), users can:
** xref:hands-on/how-tos/create-model.adoc[Create a new model].
** xref:hands-on/how-tos/create-element.adoc[Create a new child element].
** xref:hands-on/how-tos/download-model.adoc[Download the model].
** xref:hands-on/how-tos/expand-all.adoc[Expand all the model].
** xref:hands-on/how-tos/rename-model.adoc[Rename the model].
** xref:hands-on/how-tos/delete-model.adoc[Delete the model].
** xref:hands-on/how-tos/model-management.adoc#create-model[Create a new model].
** xref:hands-on/how-tos/model-management.adoc#create-element[Create a new child element].
** xref:hands-on/how-tos/model-management.adoc#download-model[Download the model].
** xref:hands-on/how-tos/explorer.adoc#expand-all[Expand all the model].
** xref:hands-on/how-tos/model-management.adoc#rename-model[Rename the model].
** xref:hands-on/how-tos/model-management.adoc#delete-model[Delete the model].
* For Semantic Elements, users can:
** xref:hands-on/how-tos/create-element.adoc[Create a new child element].
** xref:hands-on/how-tos/create-representation.adoc[Create a new representation].
** xref:hands-on/how-tos/expand-all.adoc[Expand all the children].
** xref:hands-on/how-tos/rename-element.adoc[Rename the element].
** xref:hands-on/how-tos/delete-element.adoc[Delete the element].
** xref:hands-on/how-tos/model-management.adoc#create-element[Create a new child element].
** xref:hands-on/how-tos/representation-operations.adoc#create-representation[Create a new representation].
** xref:hands-on/how-tos/explorer.adoc#expand-all[Expand all the children].
** xref:hands-on/how-tos/model-management.adoc#rename-element[Rename the element].
** xref:hands-on/how-tos/model-management.adoc#delete-element[Delete the element].
* For Representations, users can:
** xref:hands-on/how-tos/rename-representation.adoc[Rename the representation].
** xref:hands-on/how-tos/delete-representation.adoc[Delete the representation].
** xref:hands-on/how-tos/representation-operations.adoc#rename-representation[Rename the representation].
** xref:hands-on/how-tos/representation-operations.adoc#delete-representation[Delete the representation].

== {explorer-filter-bar}

The *{explorer-filter-bar}* in the {explorer} view provides the capability to highlight and xref:hands-on/how-tos/filter-explorer.adoc[filter tree items].
The *{explorer-filter-bar}* in the {explorer} view provides the capability to highlight and xref:hands-on/how-tos/explorer.adoc#filter-explorer[filter tree items].
4 changes: 2 additions & 2 deletions doc/content/modules/user-manual/pages/features/homepage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ _SysMLv2_ is an empty SysML project with only the root model, a _Package_ and a

NOTE: Every project you create will have its own xref:features/editor.adoc[Project Editor].

Explore further by referring to the following how-tos for xref:hands-on/how-tos/create-blank-project.adoc[creating blank projects], generating xref:hands-on/how-tos/create-template-project.adoc[projects from templates], or xref:hands-on/how-tos/upload-project.adoc[uploading] existing ones.
Explore further by referring to the following how-tos for xref:hands-on/how-tos/project-management.adoc#create-blank-project[creating blank projects], generating xref:hands-on/how-tos/project-management.adoc#create-template-project[projects from templates], or xref:hands-on/how-tos/project-management.adoc#upload-project[uploading] existing ones.

=== Existing Projects

The _Existing Projects_ section streamlines project navigation, allowing users to effortlessly browse through their available projects.

image::homepage-existing-projects.png[Existing Projects]

It facilitates the opening of pre-existing projects and provides essential actions for project management, including options to _xref:hands-on/how-tos/rename-project.adoc[rename]_, _xref:hands-on/how-tos/download-project.adoc[download]_, and _xref:hands-on/how-tos/delete-project.adoc[delete]_ projects.
It facilitates the opening of pre-existing projects and provides essential actions for project management, including options to _xref:hands-on/how-tos/project-management.adoc#rename-project[rename]_, _xref:hands-on/how-tos/project-management.adoc#download-project[download]_, and _xref:hands-on/how-tos/project-management.adoc#delete-project[delete]_ projects.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This feature enhances interoperability, allowing users to seamlessly exchange pr

WARNING: {product} does not currently support the {sysmlv2} Standard JSON format for import/export.

For detailed instructions on xref:hands-on/how-tos/download-project.adoc[downloading projects], xref:hands-on/how-tos/download-model.adoc[downloading models], xref:hands-on/how-tos/upload-project.adoc[uploading projects], and xref:hands-on/how-tos/upload-model.adoc[uploading models], please refer to the respective sections in the documentation.
For detailed instructions on xref:hands-on/how-tos/project-management.adoc#download-project[downloading projects], xref:hands-on/how-tos/model-management.adoc#download-model[downloading models], xref:hands-on/how-tos/project-management.adoc#upload-project[uploading projects], and xref:hands-on/how-tos/model-management.adoc#upload-model[uploading models], please refer to the respective sections in the documentation.
These sections provide step-by-step guidance on how to perform these actions within the {product} environment.

=== {sysmlv2} textual format
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit dd43544

Please sign in to comment.