Skip to content

Fix links in quick start guide #8893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix links in quick start guide #8893

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/quick-start-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Here is a simple example to show how to use the LLM API with TinyLlama.
```

You can also directly load pre-quantized models [quantized checkpoints on Hugging Face](https://huggingface.co/collections/nvidia/model-optimizer-66aa84f7966b3150262481a4) in the LLM constructor.
To learn more about the LLM API, check out the [](llm-api/index) and [](examples/llm_api_examples).
To learn more about the LLM API, check out the [docs](llm-api/index) and [examples](examples/llm_api_examples).
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 4, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify that the documentation link targets exist and render correctly.

The Markdown link formatting looks good and aligns with the PR objective. However, confirm that the paths llm-api/index and examples/llm_api_examples exist in the documentation structure and resolve correctly when the docs are built.

Run the following verification to check that the linked paths exist:

🏁 Script executed:

#!/bin/bash
# Description: Verify that the linked documentation paths exist.

# Find paths matching the link targets
echo "Searching for llm-api documentation..."
fd -t d "llm-api" docs/

echo "Searching for llm_api_examples..."
fd -t d "llm_api_examples" docs/

# Also check for .rst or .md files that might correspond to these links
echo "Checking for index files in llm-api..."
fd "index\.(rst|md)" docs/source/llm-api

echo "Checking for llm_api_examples content..."
fd "llm_api_examples\.(rst|md|html)" docs/

Length of output: 202

I found an issue with the verification results. Let me search for what actually exists in the examples directory:

Let me search for what exists in the examples directory:

I need to check what actually exists in the examples directory. Let me run a direct search:Now let me run a simple script to check what files exist in the examples directory:

🏁 Script executed:

#!/bin/bash
# Description: List all items in docs/source/examples directory

echo "=== Listing all items in docs/source/examples ==="
if [ -d "docs/source/examples" ]; then
    ls -la docs/source/examples
else
    echo "Directory docs/source/examples does not exist"
fi

echo ""
echo "=== Searching for 'examples' directory ==="
find docs -type d -name "examples" 2>/dev/null

echo ""
echo "=== Searching for any file/dir with 'llm' in name under docs ==="
find docs -iname "*llm*" 2>/dev/null

Length of output: 205

Critical issue found. The second link target doesn't exist. Let me check the docs structure to find the correct path:

🏁 Script executed:

#!/bin/bash
# Description: Map out docs/source directory structure

echo "=== Top-level contents of docs/source ==="
ls -la docs/source | grep -E '^d'

echo ""
echo "=== Search for any file mentioning llm_api_examples ==="
rg -n "llm_api_examples" docs/ 2>/dev/null || echo "No matches found"

echo ""
echo "=== Check if there's example content elsewhere ==="
find docs -type f -name "*example*" 2>/dev/null | head -20

Length of output: 226

Let me verify that the file under review actually exists and check the docs structure more broadly:


---

🏁 Script executed:

```shell
#!/bin/bash
# Description: Verify file under review and check docs structure

echo "=== Check if the file under review exists ==="
cat docs/source/quick-start-guide.md 2>/dev/null | head -100 || echo "File not found"

echo ""
echo "=== List all directories at docs root ==="
find docs -maxdepth 2 -type d 2>/dev/null | sort

echo ""
echo "=== Find quick-start-guide file ==="
find . -name "quick-start-guide.md" 2>/dev/null

Length of output: 4143

Now let me check what exists in the docs/source/examples directory:


---

🏁 Script executed:

```shell
#!/bin/bash
# Description: Check contents of docs/source/examples

echo "=== Contents of docs/source/examples ==="
ls -la docs/source/examples 2>/dev/null || echo "Directory listing failed"

echo ""
echo "=== Search for llm_api_examples in examples ==="
find docs/source/examples -name "*llm_api*" 2>/dev/null || echo "No matches"

echo ""
echo "=== All files in docs/source/examples ==="
find docs/source/examples -type f 2>/dev/null | sort

echo ""
echo "=== All directories in docs/source/examples ==="
find docs/source/examples -type d 2>/dev/null | sort

Length of output: 994

Fix broken documentation link on line 91 - examples/llm_api_examples does not exist.

The second link target does not exist in the documentation structure. The docs/source/examples/ directory contains:

  • customization.md
  • dynamo_k8s_example.rst
  • index.rst (likely the correct target)
  • kvcacheconfig.md
  • kvcacheretentionconfig.md

Change examples/llm_api_examples to the correct path, likely examples/index or another existing documentation file appropriate for LLM API examples.

The first link llm-api/index is valid and resolves correctly to docs/source/llm-api/index.md.

🤖 Prompt for AI Agents 
In docs/source/quick-start-guide.md around line 91, the second link target
"examples/llm_api_examples" is invalid; replace it with the correct existing
documentation path (e.g., "examples/index") so the link points to
docs/source/examples/index.rst (or another appropriate file under
docs/source/examples/) and ensure the markdown link becomes
[examples](examples/index).


## Next Steps

Expand Down
Loading