docs: add initial content

Author: jeanpierrefortune

.github/workflows/update-submodules.yml

@@ -0,0 +1,58 @@
+name: Update Submodules and Publish
+
+on:
+  workflow_dispatch:
+  repository_dispatch:
+    types: [update-submodules]
+  push:
+    branches:
+      - gh-pages
+
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+
+jobs:
+  update-submodules:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+          submodules: recursive
+          fetch-depth: 0
+
+      - name: Set Git user identity
+        run: |
+          git config --global user.name "Calypsonet Bot"
+          git config --global user.email "${{ github.repository }}[email protected]"
+
+      - name: Update Git submodules
+        id: commit
+        run: |
+          git submodule update --init --recursive --remote
+          git add .
+          COMMIT_MSG="Update submodules to latest commit"
+          if [[ -n $(git status --porcelain) ]]; then
+            git commit -m "$COMMIT_MSG"
+            echo "changes_detected=true" >> $GITHUB_ENV
+          else
+            echo "No changes to commit"
+            echo "changes_detected=false" >> $GITHUB_ENV
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Show the version of the submodules
+        run: git submodule foreach --recursive 'git rev-parse HEAD'
+
+      - name: Push changes if any
+        if: env.changes_detected == 'true'
+        run: |
+          git push origin HEAD:gh-pages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

LICENSE

@@ -261,8 +261,8 @@ No third-party beneficiary rights are created under this Agreement.
 
 Exhibit A - Form of Secondary Licenses Notice
 
-"This Source Code may also be made available under the following
-Secondary Licenses when the conditions for such availability set forth
+"This Source Code may also be made available under the following 
+Secondary Licenses when the conditions for such availability set forth 
 in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
 version(s), and exceptions or additional permissions here}."
 

README.md

@@ -1 +1,67 @@
-# calypsonet-terminal-api-docs
+# Calypso Networks Association Terminal API documentation
+
+[![License](https://img.shields.io/badge/License-EPL_2.0-red.svg)](https://opensource.org/licenses/EPL-2.0)
+
+Central repository for design documentation of all **Calypso Terminal API** libraries, including **UML diagrams** and conception documents.
+
+## Repository Structure
+
+This repository uses two main branches:
+- `main`: Contains the repository configuration and workflows
+- `gh-pages`: Contains the actual documentation and Jekyll configuration, published at [https://docs.terminal-api.calypsonet.org/](https://docs.terminal-api.calypsonet.org/)
+
+## Managing Documentation Sources
+
+### Adding a New Library Documentation
+
+To add documentation for a new library:
+
+```bash
+# Switch to `doc` branch
+git checkout doc
+
+# Add the submodule pointing to the doc branch
+git submodule add -b doc https://github.com/calypsonet/[library-name].git [library-name]
+
+# Commit the changes
+git add .
+git commit -m "feat: add documentation for [library-name]"
+git push origin doc
+```
+
+### Removing a Library Documentation
+
+To remove documentation for a library:
+
+```bash
+# Switch to `gh-pages` branch
+git checkout gh-pages
+
+# Remove the submodule
+git submodule deinit -f [library-name]
+rm -rf .git/modules/[library-name]
+git rm -f [library-name]
+
+# Commit the changes
+git commit -m "feat: remove documentation for [library-name]"
+git push origin gh-pages
+```
+
+## Automatic Updates
+
+This repository includes a GitHub Action that automatically updates all submodules to their latest commits. The action:
+
+- Runs on manual trigger, repository dispatch event, or push to gh-pages
+- Updates all submodules recursively
+- Commits and pushes changes if updates are detected
+- Uses a dedicated bot account for commits
+
+You can view the action workflow in [`/.github/workflows/update-submodules.yml`](https://github.com/calypsonet/terminal-api-doc/blob/main/.github/workflows/update-submodules.yml).
+
+## Contributing
+
+Please read our [contribution guidelines](https://terminal-api.calypsonet.org/community/contributing/) before submitting any changes.
+
+## License
+
+This project is licensed under the Eclipse Public License v. 2.0. See [LICENSE](LICENSE) for details.