diff --git a/doc/content/modules/ROOT/nav.adoc b/doc/content/modules/ROOT/nav.adoc index 7186f7a..b48fd59 100644 --- a/doc/content/modules/ROOT/nav.adoc +++ b/doc/content/modules/ROOT/nav.adoc @@ -3,7 +3,7 @@ // A navigation file contains one or more AsciiDoc lists. // Each navigation file must be declared in the component descriptor if you want it to be displayed in the component’s navigation menu. * xref:index.adoc[] +* xref:getting-started.adoc[] * xref:product-legal:index.adoc[] - * xref:installation-guide:index.adoc[] -include::user-manual:partial$nav.adoc[] \ No newline at end of file +include::user-manual:partial$nav.adoc[] diff --git a/doc/content/modules/ROOT/pages/general-information.adoc b/doc/content/modules/ROOT/pages/general-information.adoc index fa00295..e514fa1 100644 --- a/doc/content/modules/ROOT/pages/general-information.adoc +++ b/doc/content/modules/ROOT/pages/general-information.adoc @@ -1,8 +1,11 @@ = Overview -* Name: {product-name} +{product-name} project provides an open-source and interoperable tool for editing SysMLv2 models conforming to the OMG Standard, for the MBSE community. +This software will prominently showcase structured editors: graphical, form-based and tables, effectively utilizing the capabilities of the Sirius Web modeling platform. +Additionally, the project will ensure seamless integration with Open-Source solutions like [Papyrus](https://eclipse.dev/papyrus/) and [Capella](https://mbse-capella.org/), further enhancing the usability and versatility of the tool. == Source code -* License: xref:product-legal:index.adoc[Obeo] +* License: xref:product-legal:index.adoc[EPL v2] +* Maintainers: https://projects.eclipse.org/projects/modeling.syson/who == Tracker @@ -10,4 +13,4 @@ == Communication -* Website: {website} \ No newline at end of file +* Website: {website} diff --git a/doc/content/modules/ROOT/pages/getting-started.adoc b/doc/content/modules/ROOT/pages/getting-started.adoc new file mode 100644 index 0000000..e4cebce --- /dev/null +++ b/doc/content/modules/ROOT/pages/getting-started.adoc @@ -0,0 +1,13 @@ += Getting started with {product-name} + +A very simple demo for using {product-name}. + +== What is {product-name} ? +// What are the quickest explanations of what this product is and what its core features do? + + +== How to install {product-name} ? +// What are the simplest steps to install and use the product? + +// What are the most important questions new users will have? +// What are the cool \ No newline at end of file diff --git a/doc/content/modules/ROOT/pages/overview.adoc b/doc/content/modules/ROOT/pages/overview.adoc new file mode 100644 index 0000000..baf9191 --- /dev/null +++ b/doc/content/modules/ROOT/pages/overview.adoc @@ -0,0 +1,2 @@ += Overview + diff --git a/doc/content/modules/installation-guide/pages/index.adoc b/doc/content/modules/installation-guide/pages/index.adoc index ad95cad..06f3e60 100644 --- a/doc/content/modules/installation-guide/pages/index.adoc +++ b/doc/content/modules/installation-guide/pages/index.adoc @@ -6,4 +6,7 @@ include::executables.adoc[leveloffset=+1] == Installation procedure [.small .gray]#_Details how to install the product. Details if the software comes with an installer or with a kind of assistant for the configuration or the steps to do the installation by hand._# + +include::troubelshooting.adoc[leveloffset=+1] + include::migration-process.adoc[leveloffset=+1] \ No newline at end of file diff --git a/doc/content/modules/installation-guide/pages/troubleshooting.adoc b/doc/content/modules/installation-guide/pages/troubleshooting.adoc new file mode 100644 index 0000000..cc2010c --- /dev/null +++ b/doc/content/modules/installation-guide/pages/troubleshooting.adoc @@ -0,0 +1 @@ += Troubleshooting steps \ No newline at end of file