Skip to content

Commit

Permalink
Initial doc contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
mbats committed Nov 28, 2023
1 parent 9e8a792 commit 6beaf88
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 5 deletions.
4 changes: 2 additions & 2 deletions doc/content/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
include::user-manual:partial$nav.adoc[]
9 changes: 6 additions & 3 deletions doc/content/modules/ROOT/pages/general-information.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
= 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

* Bug tracker: {bug}

== Communication

* Website: {website}
* Website: {website}
13 changes: 13 additions & 0 deletions doc/content/modules/ROOT/pages/getting-started.adoc
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions doc/content/modules/ROOT/pages/overview.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
= Overview

3 changes: 3 additions & 0 deletions doc/content/modules/installation-guide/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Troubleshooting steps

0 comments on commit 6beaf88

Please sign in to comment.