Skip to content

[docs] Installation examples using relative imports need clarification on required folder structure #33

@CiscoFran10

Description

@CiscoFran10

Describe the issue

The installation documentation includes examples that rely on relative imports, but it does not clearly explain that these imports must be adjusted to match the consumer’s local folder structure.

Because the examples are presented as copy-paste–ready, developers may assume the paths are universal. When they are not, this can lead to import errors and a few minutes of unnecessary debugging during initial setup.


Current behavior

  • Docs show valid examples, but:
    • They rely on relative paths
    • There is no explicit note that paths must match the project’s directory structure
  • New users may copy the examples verbatim and encounter broken imports
  • Debugging is simple, but the cause is not immediately obvious

Expected behavior

  • Installation docs should explicitly mention that:
    • Relative import paths depend on the consumer’s folder structure
    • Paths may need to be adjusted based on where the file lives
  • A short inline note or callout near the examples would be sufficient
  • This would help set correct expectations during first-time setup

Suggested improvement (example)

Add a brief note near the relevant examples, such as:

Note: These imports use relative paths. You may need to adjust them to match your project’s folder structure.


Additional context

This is a small documentation improvement, but it directly impacts onboarding and developer experience. Clarifying this upfront can prevent avoidable confusion during installation, especially for first-time Kumo users.


Environment and versions

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions