docs: add writerside docs to the project for mavlink

Asana: https://app.asana.com/0/1203851531040615/1208988780485725/f

.github/workflows/docs.yml

@@ -0,0 +1,187 @@
+name: Release docs
+
+on:
+  push:
+    tags:
+      - 'docs-v[0-9]+.[0-9]+.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+permissions:
+  contents: write
+  id-token: write
+  pages: write
+
+env:
+  INSTANCE: 'Writerside/am'
+  DOCKER_VERSION: '243.21565'
+  PDF: 'PDF.xml'
+  CONFIG_JSON_PRODUCT: 'AM'
+  ALGOLIA_ID: 'FS4LOABGZR'
+  ALGOLIA_INDEX_NAME: 'asv.mavlink'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      instance_id_upper: ${{ steps.define-ids.outputs.instance_id_upper }}
+      algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }}
+      artifact: ${{ steps.define-ids.outputs.artifact }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Define instance ID
+        id: define-ids
+        run: |
+          INSTANCE_ID="${INSTANCE#*/}"
+          INSTANCE_ID_UPPER=$(echo "$INSTANCE_ID" | tr '[:lower:]' '[:upper:]')
+          ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip"
+          ALGOLIA_ARTIFACT="algolia-indexes-${INSTANCE_ID_UPPER}.zip"
+          
+          echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER"
+          echo "ARTIFACT: $ARTIFACT"
+          echo "ALGOLIA_ARTIFACT: $ALGOLIA_ARTIFACT"
+          
+          echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV
+          echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV
+          echo "ALGOLIA_ARTIFACT=$ALGOLIA_ARTIFACT" >> $GITHUB_ENV
+          
+          echo "instance_id_upper=$INSTANCE_ID_UPPER" >> $GITHUB_OUTPUT
+          echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT
+          echo "algolia_artifact=$ALGOLIA_ARTIFACT" >> $GITHUB_OUTPUT
+          
+      - name: Build Writerside docs using Docker in ZIP
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+          artifact: ${{ env.ARTIFACT }}
+
+      - name: Build Writerside docs using Docker in PDF
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+          pdf: ${{ env.PDF }}
+
+      - name: Save artifact with build results
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: |
+            artifacts/pdfSource${{ env.INSTANCE_ID_UPPER }}.pdf
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+            artifacts/${{ env.ALGOLIA_ARTIFACT }}
+          retention-days: 1
+
+  test:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Test documentation
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.INSTANCE }}
+
+  create-release:
+    needs: [build, test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Show outputs
+        run: |
+          echo "INSTANCE_ID_UPPER: ${{ needs.build.outputs.instance_id_upper }}"
+          echo "ARTIFACT: ${{ needs.build.outputs.artifact }}"
+          echo "ALGOLIA_ARTIFACT: ${{ needs.build.outputs.algolia_artifact }}"
+      
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref }}
+          name: "Release ${{ github.ref_name }}"
+          draft: false
+          prerelease: ${{ contains(github.ref, 'alpha') }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GIHUB_NUGET_AUTH_TOKEN }}
+
+      - name: Upload artifact to release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            artifacts/pdfSource${{ needs.build.outputs.instance_id_upper }}.pdf
+            artifacts/${{ needs.build.outputs.artifact }}
+            artifacts/report.json
+            artifacts/${{ needs.build.outputs.algolia_artifact }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GIHUB_NUGET_AUTH_TOKEN }}
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: [ build, test, create-release ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.artifact }}" -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Package and upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+  publish-indexes:
+    needs: [build, test, create-release, deploy]
+    runs-on: ubuntu-latest
+    container:
+      image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: artifacts
+      - name: Unzip Algolia artifact
+        run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.algolia_artifact }}" -d algolia-indexes
+      - name: Update Algolia Index
+        run: |
+          if [ -z "${{ secrets.ALGOLIA_KEY }}" ]; then
+            echo "ALGOLIA_KEY secret is not set in GitHub Secrets"
+            exit 1
+          else
+            env "algolia-key=${{ secrets.ALGOLIA_KEY }}" java -jar /opt/builder/help-publication-agent.jar \
+            update-index \
+            --application-name ${{ env.ALGOLIA_ID }} \
+            --index-name ${{ env.ALGOLIA_INDEX_NAME }} \
+            --product ${{ env.CONFIG_JSON_PRODUCT }} \
+            --index-directory algolia-indexes/ \
+            2>&1 | tee algolia-update-index-log.txt
+          fi

.gitignore

@@ -350,3 +350,4 @@ MigrationBackup/
 .ionide/
 
 /src/.idea/
+/docs/.idea/

docs/Writerside/am.tree

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE instance-profile
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="am"
+                  name="Asv Mavlink" start-page="welcome-page.md">
+    <toc-element topic="welcome-page.md">
+        <toc-element topic="get-started.md">
+            <toc-element topic="With-Virtual-Connection.md"/>
+            <toc-element topic="With-Ardu-SITL.md"/>
+        </toc-element>
+    </toc-element>
+    <toc-element toc-title="CLI">
+        <toc-element topic="packet-code-generation.md"/>
+        <toc-element topic="packet-viewer.md"/>
+        <toc-element topic="proxy.md"/>
+        <toc-element topic="mavlink.md"/>
+        <toc-element topic="benchmark-serialization.md"/>
+        <toc-element topic="devices-info.md"/>
+        <toc-element topic="emulate-adsb-receiver.md"/>
+        <toc-element topic="export-sdr-data.md"/>
+        <toc-element topic="ftp-browser.md"/>
+        <toc-element topic="ftp-tree.md"/>
+        <toc-element topic="generate-fake-diagnostic-data.md"/>
+    </toc-element>
+    <toc-element toc-title="About">
+        <toc-element topic="licensing-information.md"/>
+        <toc-element topic="contact-information-for-feedback.md"/>
+    </toc-element>
+    <toc-element topic="for-developers.md"/>
+</instance-profile>

docs/Writerside/c.list

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE categories
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories>
+    <category id="wrs" name="Writerside documentation" order="1"/>
+</categories>

docs/Writerside/cfg/PDF.xml

@@ -0,0 +1,8 @@
+<pdf landscape="true">
+    <cover-page>
+        <title>Asv Mavlink</title>
+        <description>Documentation</description>
+        <copyright>(c) 2023 Asv Soft LLC</copyright>
+    </cover-page>
+    <layout>Windows</layout>
+</pdf>

docs/Writerside/cfg/buildprofiles.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd">
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <variables></variables>
+    <build-profile instance="am">
+        <variables>
+            <primary-color>blue</primary-color>
+            <link-color>blue</link-color>
+            <custom-favicons>asv-mavlink-128.png</custom-favicons>
+            <algolia-id>FS4LOABGZR</algolia-id>
+            <algolia-index>asv.mavlink</algolia-index>
+            <algolia-api-key>2e71182668928729892da193d411c26a</algolia-api-key>
+            <algolia-show-logo>true</algolia-show-logo>
+            <noindex-content>false</noindex-content>
+            <ignore-problems>MRK056</ignore-problems>
+        </variables>
+
+        <footer>
+            <link href="https://docs.asv.me/">Official website</link>
+            <link href="https://github.com/asv-soft/asv-mavlink/issues">Issue tracker and Support</link>
+            <link href="mailto:[email protected]">Contact us</link>
+            <link href="https://github.com/asv-soft/asv-drones">Asv.Drones</link>
+
+            <copyright>(c) 2023 Asv Soft LLC</copyright>
+        </footer>
+    </build-profile>
+
+</buildprofiles>

docs/Writerside/cfg/glossary.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE terms SYSTEM "https://resources.jetbrains.com/writerside/1.0/glossary.dtd">
+<terms>
+    <term name="foo">
+        Description of what "foo" is.
+    </term>
+</terms>

docs/Writerside/redirection-rules.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
+<rules>
+    <!-- format is as follows
+    <rule id="<unique id>">
+        <accepts>page.html</accepts>
+    </rule>
+    -->
+    <rule id="22a83207">
+        <description>Created after removal of "🧊 Asv.Mavlink" from Instance Name</description>
+        <accepts>asv-mavlink.html</accepts>
+    </rule>
+    <rule id="550a4f17">
+        <description><![CDATA[Created after removal of "<emulate-ADSB-receiver1.md>" from Instance Name]]></description>
+        <accepts>emulate-ADSB-receiver1.html</accepts>
+    </rule>
+    <rule id="3954fc42">
+        <description>Created after removal of "CLI: Emulate ADSB receiver" from Asv Mavlink</description>
+        <accepts>emulate-ADSB-receiver.html</accepts>
+    </rule>
+    <rule id="c16f26b">
+        <description>Created after removal of "CLI: Packet code generation" from Asv Mavlink</description>
+        <accepts>packet-code-generation.html</accepts>
+    </rule>
+    <rule id="671d35a6">
+        <description><![CDATA[Created after removal of "<packet-code-generation1.md>" from Asv Mavlink]]></description>
+        <accepts>packet-code-generation1.html</accepts>
+    </rule>
+    <rule id="66ec7796">
+        <description><![CDATA[Created after removal of "<emulate-ADSB-receiver1.md>" from Asv Mavlink]]></description>
+        <accepts>emulate-ADSB-receiver1.html</accepts>
+    </rule>
+    <rule id="23f6abd5">
+        <description>Created after removal of "Emulate ADSB receiver" from Asv Mavlink</description>
+        <accepts>emulate-ADSB-receiver.html</accepts>
+    </rule>
+    <rule id="3d953e26">
+        <description>Created after removal of "Benchmark-serialization" from Asv Mavlink</description>
+        <accepts>benchmark-serialization.html</accepts>
+    </rule>
+</rules>

docs/Writerside/topics/About/contact-information-for-feedback.md

@@ -0,0 +1,33 @@
+# Contact Information for Feedback
+
+We value your feedback and welcome your thoughts, suggestions, and contributions to make Asv.Mavlink even better. 
+There are two primary ways to get in touch with us:
+
+## GitHub Issues
+
+If you encounter a bug, have a feature request, or want to participate in discussions about Asv.Mavlink, our GitHub Issues page is the place to go. 
+You can create a new issue or contribute to existing discussions.
+
+👉 [GitHub Issues](https://github.com/asv-soft/asv-mavlink/issues)
+
+## Official Email
+
+For more direct and private communication, you can reach out to us via our official email. 
+Feel free to share your thoughts, report issues, or inquire about any aspect of Asv.Mavlink.
+
+📧 [Our Official Email Address](mailto:[email protected])
+
+## How to Provide Effective Feedback
+
+When providing feedback, consider the following to help us better understand and address your needs:
+
+- **Clearly Describe the Issue or Suggestion:**
+  - Provide detailed information about the problem or suggestion. Include steps to reproduce issues if applicable.
+
+- **Include Relevant Information:**
+  - Mention the version of Asv.Mavlink you are using, your operating system, and any other relevant details.
+
+- **Be Constructive:**
+  - Constructive feedback helps us identify areas for improvement. Share your insights and thoughts in a positive and constructive manner.
+
+We appreciate your time and effort in helping us enhance Asv.Mavlink. Thank you for being a part of our community!