Skip to content

Enhance documentation with installation and usage steps #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
berezovskyi wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Enhance documentation with installation and usage steps #243

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ To generate the init file, checkout https://github.com/Open-MBEE/flexo-mms-layer
.. code:: bash

cd deploy
# install dependencies
npm ci
# approve module download [y]
npx ts-node -v
Comment on lines +103 to +104
Copy link

Copilot AI Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command npx ts-node -v is unnecessary after running npm ci, which already installs ts-node as a dependency (as shown in deploy/package.json). This step can be removed since ts-node will be available in node_modules after the dependency installation. If the intention is to verify the installation, a comment explaining this would be more appropriate than suggesting users need to manually approve a download.

Copilot uses AI. Check for mistakes.
npx ts-node src/main.ts $APP_URL > cluster.trig

Where ``$APP_URL`` is the root URL for where the Flexo MMS Layer 1 instance is deployed, e.g., ``https://mms.openmbee.org``. For local development, we simply use the stand-in ``http://layer1-service``.
Expand All @@ -111,6 +115,13 @@ Apply the initialization file

Once the initialization file has been generated at ``cluster.trig``, apply this file to your empty quadstore (for example, by using its Graph Store Protocol API to insert the data) before using Flexo MMS.

.. code:: bash

# POSIX shell
curl -X POST -H "Content-Type: application/trig" --data-binary @src/test/resources/cluster.trig http://localhost:3030/ds/data
# or PowerShell
Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "src/test/resources/cluster.trig" -ContentType "application/trig"
Comment on lines +121 to +123
Copy link

Copilot AI Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file path in the curl command does not match the location where the cluster.trig file is generated. According to line 105, the file is generated in the deploy directory as cluster.trig, but the curl command references src/test/resources/cluster.trig. The path should be updated to cluster.trig or deploy/cluster.trig depending on the working directory context.

Suggested change
curl -X POST -H "Content-Type: application/trig" --data-binary @src/test/resources/cluster.trig http://localhost:3030/ds/data
# or PowerShell
Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "src/test/resources/cluster.trig" -ContentType "application/trig"
curl -X POST -H "Content-Type: application/trig" --data-binary @cluster.trig http://localhost:3030/ds/data
# or PowerShell
Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "cluster.trig" -ContentType "application/trig"

Copilot uses AI. Check for mistakes.
Comment on lines +121 to +123
Copy link

Copilot AI Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file path in the Invoke-WebRequest command does not match the location where the cluster.trig file is generated. According to line 105, the file is generated in the deploy directory as cluster.trig, but the PowerShell command references src/test/resources/cluster.trig. The path should be updated to cluster.trig or deploy/cluster.trig depending on the working directory context.

Suggested change
curl -X POST -H "Content-Type: application/trig" --data-binary @src/test/resources/cluster.trig http://localhost:3030/ds/data
# or PowerShell
Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "src/test/resources/cluster.trig" -ContentType "application/trig"
curl -X POST -H "Content-Type: application/trig" --data-binary @cluster.trig http://localhost:3030/ds/data
# or PowerShell
Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "cluster.trig" -ContentType "application/trig"

Copilot uses AI. Check for mistakes.

Performance Considerations
--------------------------

Expand Down