Skip to content

Discrepancies in the documentation #117

@Nitish-bot

Description

@Nitish-bot
  1. The instructions on the website for installing python dependencies say

pip install -e ./packages/python-wrapper

but the actual folder is named pythonWrapper not sure if this is the correct naming convention. Although a small issue, took me over half an hour to figure out why it wouldnt work because I was blindly copy pasting the commands from the website.

the correct command should be

pip install -e ./packages/pythonWrapper


  1. The docker compose command is also erroneous wherein it says

docker-compose up -d

which is firstly deprecated using v1 of docker compose as opposed to the new plugin but more importanly, the docker-compose file is not in the parent folder which can cause errors. It lives inside backend/docker-compose.yaml.

The correct command should be

docker compose -f ./backend/docker-compose.yml up -d


  1. The github guide page under the Technical > Developer Hub > Getting started > Installation Guide > Github guide is empty, maybe it's work in progress or it doesn't render correctly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions