From 7e80fdde77aedb3d328a8d4f7b00ede21f566967 Mon Sep 17 00:00:00 2001 From: Nolwenn <28621493+NoB0@users.noreply.github.com> Date: Tue, 7 May 2024 14:54:30 +0200 Subject: [PATCH] Address review comments --- docs/source/pkg_client.rst | 6 +++--- docs/source/pkg_server.rst | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/pkg_client.rst b/docs/source/pkg_client.rst index 896b4c7..82e34ef 100644 --- a/docs/source/pkg_client.rst +++ b/docs/source/pkg_client.rst @@ -15,16 +15,16 @@ To start PKG Client, run the following commands in the directory `pkg_client`: npm install npm start -Note that `npm install` only needs to be run once, unless the dependencies change. For more information on how to run the client, refer to the README in the `pkg_client` directory. +Note that `npm install` only needs to be run once, unless the dependencies change. For more information on how to run the client, refer to the `README ` in the `pkg_client` directory. In case the server is not running on the default port (i.e., 5000), `PKG_API_BASE_URL` in `pkg_client/public/config.json` must be updated accordingly. Features -------- -PKG Client provides the following features: +PKG Client has the following pages: * **Login/Registration**: To access their PKG, users must be logged in. If they do not have an account, they can register. * **Home**: The home page provides a text input field where users can enter their management instructions (i.e., add, remove, and retrieve statements) in natural language. After being processed by the server, the outcome of the instructions is displayed. The home page also provides a button to visualize the PKG. * **Populate PKG**: Users can populate their PKG by adding or removing statements via a form. This feature assumes that the user is familiar with the `PKG vocabulary `. -* **Explore PKG**: Users can visualize their PKG or a part of it as an RDF graph. The visualization is generated based on the results of a SPARQL query, hence, this feature is intended for advised users. \ No newline at end of file +* **Explore PKG**: Users can visualize their PKG or a part of it as an RDF graph. The visualization is generated based on the results of a SPARQL query, hence, this feature is intended for advanced users. \ No newline at end of file diff --git a/docs/source/pkg_server.rst b/docs/source/pkg_server.rst index 8249301..5de98aa 100644 --- a/docs/source/pkg_server.rst +++ b/docs/source/pkg_server.rst @@ -24,6 +24,6 @@ Routes The server has four main routes that relate to the :doc:`features available ` in the PKG Client: * `/auth`: Handles the authentication of users and service providers. -* `/nl`: Handles natural language instructions. +* `/nl`: Handles natural language instructions provided by users to manage the PKG. * `/statements`: Manages the addition and deletion of statements via forms. * `/explore`: Handles SPARQL queries for the visualization of the PKG.