Skip to content

[BUG] Fix incorrect ingestion path in the "Quick start Guide" #19

@virginia-delos

Description

@virginia-delos

Bug Description

The user guide provides the following ingestion example:

python manage.py ingest documentation ./docs/*.pdf

However, the ./docs/ directory does not clearly correspond to the topic structure created earlier in the guide. There is also no explanation of where documents should be placed before running the ingestion command.

This inconsistency can cause users to place files in an incorrect directory and encounter ingestion errors.

To Reproduce

  1. Follow the guide to create a topic:
    python manage.py starttopic documentation
  2. Place PDF files in a different directory (e.g., ./data/documentation/) or leave the default structure as created.
  3. Run:
    python manage.py ingest documentation ./docs/*.pdf
  4. Observe that the ./docs/ path may not exist or does not match the expected folder structure, resulting in failure to ingest files.

Expected Behavior

The ingestion example in the guide should use a directory path that matches the expected project structure (e.g., ./data/documentation/*.pdf) and clearly explain where documents must be placed before ingestion.

Actual Behavior

The guide references a ./docs/ directory without explaining its relation to the topic structure, which may lead to missing file errors or confusion about where documents should be stored.

Error Output

No such file or directory: './docs/*.pdf'

Environment

  • OS: [Windows 11]
  • Python version: [Python 3.11.9]
  • CogSol version: [0.2.0]

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions