Skip to content

docs(nooa_memory): correct the relative depth on the quickstart link 🤖🤖🤖 - #103

Merged
furgalep merged 1 commit into
NVIDIA-NeMo:mainfrom
Hotragn:docs/fix-nooa-memory-example-link
Aug 10, 2026
Merged

docs(nooa_memory): correct the relative depth on the quickstart link 🤖🤖🤖#103
furgalep merged 1 commit into
NVIDIA-NeMo:mainfrom
Hotragn:docs/fix-nooa-memory-example-link

Conversation

@Hotragn

@Hotragn Hotragn commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Fixes the relative depth on the quickstart link in packages/nooa-memory/src/nooa_memory/README.md. The file sits four levels below the repo root, not three, so the link 404s on GitHub.

Verified from the file's own directory:

../../../examples/quickstart/12_memory.py     -> packages/examples/quickstart/12_memory.py   missing
../../../../examples/quickstart/12_memory.py  -> examples/quickstart/12_memory.py            exists

Same class as #64, which fixed the tests/memory/ link in this same file.

I found it by resolving every relative markdown link in the repo rather than by reading — it's the only depth-bug of its kind left, and every other relative link in the tree resolves.

Related issues

None. Separately: the four remaining examples/memory_bench/ references in this README (lines 8, 303, 401, 449) point at a directory that is absent at every depth, so no path adjustment fixes them — I've filed that as its own issue rather than guess at the intended target here, since the right answer is either publishing the directory or dropping the references, and that's a maintainer call.

Checklist

  • Code follows the project style (uv run ruff check . and uv run ruff format --check . pass)
  • Tests added/updated and passing (uv run pytest) — docs-only, no test surface
  • Docs updated if behavior or public APIs changed
  • New source files carry an SPDX license header — no new files

🤖🤖🤖

This README sits at packages/nooa-memory/src/nooa_memory/, so reaching the repo
root takes four levels, not three. `../../../examples/quickstart/12_memory.py`
resolves to `packages/examples/quickstart/12_memory.py`, which does not exist, so
the link 404s on GitHub.

Verified from the file's own directory:

    ../../../examples/quickstart/12_memory.py     -> packages/examples/...  missing
    ../../../../examples/quickstart/12_memory.py  -> examples/...           exists

Same class as NVIDIA-NeMo#64, which fixed the tests/memory/ link in this file.

The remaining `examples/memory_bench/` references in this README are a separate
problem: that directory is absent at every depth, so no path adjustment fixes
them. Reported separately rather than guessed at here.

Signed-off-by: hotragn <hotragn.pettugani_2024@woxsen.edu.in>

@furgalep furgalep left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@furgalep
furgalep merged commit 8237a88 into NVIDIA-NeMo:main Aug 10, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants