[doc] Initial contribution

.gitignore

@@ -94,3 +94,6 @@ test-results/
 playwright-report/
 blob-report/
 playwright/.cache/
+
+# Antora
+doc/docs-site/build/

CHANGELOG.adoc

@@ -176,7 +176,7 @@ This will use a transactional event listener to add the dependency to the librar
 - https://github.com/eclipse-sirius/sirius-web/issues/5653[#5653] Add support for indexing models in Elasticsearch.
 Models are asynchronously indexed in Elasticsearch, which will allow advanced and cross-project search in the future.
 This feature is opt-in: Sirius Web won't try to index models if it is not configured to do so.
-You can check `doc/how-to/debug-elasticsearch-related-issues.adoc` to configure Sirius Web with Elasticsearch
+You can check xref:developer-guide:hands-on/how-tos/debug-elasticsearch.adoc[] to configure Sirius Web with Elasticsearch
 - https://github.com/eclipse-sirius/sirius-web/issues/5743[#5743] [datatree] Add support for data trees.
 A new module `sirius-components-datatree` has been created to:
 * Define data trees in the backend
@@ -2730,7 +2730,7 @@ The behavior is controlled by the new _Drop Node_ tools defined on the target el
 - https://github.com/eclipse-sirius/sirius-web/issues/1982[#1982] [diagram] Make the node label non required
 - https://github.com/eclipse-sirius/sirius-web/issues/2482[#2482] [diagram] Add the support for TOP_CENTER inside label location. Other inside label locations will be supported later.
 - https://github.com/eclipse-sirius/sirius-web/issues/2256[#2256] [diagram] Add the possibility to contribute custom shape.
-See the `EllipseNode` example and link:doc/how-to/contribute-custom-node.adoc[the documentation] for more details.
+See the `EllipseNode` example and xref:developer-guide:hands-on/how-tos/custom-diagram-node.adoc[the documentation] for more details.
 Note that the custom shape replaces the parametric SVG, which is deprecated and will be removed in a future version.
 - https://github.com/eclipse-sirius/sirius-web/issues/2512[#2512] [diagram] Add the support for multi-line label in reactflow.
 That includes the support during the direct edit.
@@ -3164,7 +3164,7 @@ The filter button inside the filter bar allows to filter (hide) all visible tree
 +
 image:doc/screenshots/filterBarFilterButton.png[Filter Bar Filter Button,30%,30%]
 - https://github.com/eclipse-sirius/sirius-components/issues/1914[#1914] [form] It is now possible for applications to provide their own custom widgets without forking Sirius Components.
-See link:doc/how-to/contribute-custom-widget.adoc[the documentation] for more details.
+See xref:developer-guide:custom-widget.adoc[the documentation] for more details.
 
 - https://github.com/eclipse-sirius/sirius-components/issues/1830[#1830] [layout] This feature is experimental and can be activated on a diagram by adding "__EXPERIMENTAL" to its name.
 The new algorithm does the minimum possible to place node without overlap.

doc/.vale.ini

@@ -0,0 +1,16 @@
+StylesPath = styles
+
+MinAlertLevel = warning
+
+Packages = Microsoft, Google, RedHat,  proselint, write-good, alex, Readability, Joblint
+
+[*.adoc]
+BasedOnStyles = Vale, Microsoft, Google, RedHat, proselint, write-good, alex, Readability, Joblint
+
+### Deactivate individual rules ###
+# Style1.Rule1 = NO
+Joblint.DevEnv = NO
+RedHat.Contractions = NO
+RedHat.Spelling = NO
+Vale.Spelling = NO
+write-good.E-Prime = NO

doc/Dockerfile

@@ -0,0 +1,43 @@
+FROM alpine:latest AS build
+
+RUN apk add npm
+
+WORKDIR /usr/app
+
+COPY doc-ui /usr/app
+
+RUN npm install
+RUN ./node_modules/gulp/bin/gulp.js bundle
+
+FROM alpine:latest AS ui
+
+COPY --from=build /usr/app/build/ui-bundle.zip /usr/app/ui-bundle.zip
+
+
+FROM alpine:latest
+
+RUN apk add git
+RUN apk add npm
+RUN apk add ruby ruby-dev gcc g++ make
+
+RUN mkdir /home/antora
+
+WORKDIR  /home/antora
+
+COPY docs-site/package.json .
+
+RUN npm install
+RUN gem install asciidoctor
+RUN gem install asciidoctor-pdf
+RUN gem install rouge
+RUN gem install kramdown-asciidoc
+
+RUN apk del ruby-dev gcc g++ make
+
+ENV PATH="$PATH:/home/antora/node_modules/@antora/cli/bin/"
+
+COPY --from=ui /usr/app/ui-bundle.zip .
+
+WORKDIR /usr/app
+
+CMD ["antora", "--clean", "--stacktrace", "--log-failure-level=warn", "--log-level=all", "/usr/app/doc/docs-site/antora-playbook.yml"]

doc/content/antora.yml

@@ -0,0 +1,37 @@
+name: sirius-web
+title: Sirius Web
+version: true
+nav:
+  - modules/ROOT/nav.adoc
+
+asciidoc:
+  attributes:
+    github-project: "eclipse-sirius/sirius-web"
+    source-code-url: "https://github.com/{github-project}"
+    bug-url: "{source-code-url}/issues"
+    changelog-url: "{source-code-url}/blob/master/CHANGELOG.adoc"
+    details: "Details"
+    diag-toolbar: "Contextual Toolbar"
+    editor: "Project Editor"
+    explorer-filter-bar: "Project Explorer Filter Bar"
+    explorer-menu: "Element Options Menu"
+    explorer: "Project Explorer"
+    forum-url: "{source-code-url}/discussions"
+    homepage: "Projects Browser"
+    mbse: "Model-Based Systems Engineering"
+    milestones: "{source-code-url}/milestones"
+    packages-url: "{source-code-url}/packages/2069579/versions"
+    product: "Sirius Web"
+    product-artefact: "sirius-web"
+    product-jar: "{product-artefact}-application-YYYY.M.X.jar"
+    projects-list: "Projects List"
+    projects-list-menu: "Project Options Menu"
+    query-view: "Query"
+    related-elements: "Related Elements"
+    representations-view: "Representations"
+    resources-url: "https://eclipse.dev/sirius/sirius-web.html"
+    git-ssh-url: "git@github.com:eclipse-sirius/sirius-web.git"
+    sirius: "Sirius"
+    product-tag: "v2025.6.10"
+    validation: "Validation"
+    website-url: "https://eclipse.dev/sirius/sirius-web.html"

doc/content/modules/ROOT/README

@@ -0,0 +1,6 @@
+Recommended; Reserved
+
+Directory that contains the ROOT module.
+This special directory does not appear in the output path.
+Instead, it becomes the parent folder of any additional, named modules that you create in a component.
+The directory name must be written in all uppercase letters.

doc/content/modules/ROOT/assets/README

@@ -0,0 +1,3 @@
+Optional; Reserved
+
+Directory where multimedia and supplemental files are organized by content type.

doc/content/modules/ROOT/assets/attachments/README

@@ -0,0 +1,3 @@
+Optional; Reserved
+
+Directory that contains supplemental materials, such as PDFs or ZIP files, that readers can download via a link created in a page using the AsciiDoc link macro.

doc/content/modules/ROOT/assets/images/README

@@ -0,0 +1,3 @@
+Optional; Reserved
+
+Directory that contains pictures, screenshots, diagrams, and other graphics files that are displayed in a page using the AsciiDoc image macro.

doc/content/modules/ROOT/assets/images/README copy

@@ -0,0 +1,3 @@
+Optional; Reserved
+
+Directory that contains pictures, screenshots, diagrams, and other graphics files that are displayed in a page using the AsciiDoc image macro.