Skip to content

Links replace #186

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
alex-akv wants to merge 2 commits into
base: main
Choose a base branch
from
+3 −3
Open

Links replace #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
299ce19
Modifying the links
alex-akv Nov 25, 2025
335ed4e
Modifying the links
alex-akv Nov 25, 2025
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
4 changes: 2 additions & 2 deletions examples/jupyterlab/experiment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ The included `files/experiment.ipynb` shows a typical workflow:
## Getting Started

### Prerequisites
- Agent-sandbox installed ([Installation Guide](../../README.md#Installation)
- JupyterLab deployed ([Installation Guide](./README.md))
- Agent-sandbox installed ([Installation Guide](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/README.md#installation))
- JupyterLab deployed ([Installation Guide](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/examples/jupyterlab/README.md))
Copy link
Member

@janetkuo janetkuo Nov 26, 2025

Choose a reason for hiding this comment

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

Ideally it should link to the doc in the same commit (instead of main). Would you explain why this change is needed?

Copy link

@jkallogjeri jkallogjeri Dec 1, 2025

Choose a reason for hiding this comment

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

This change is required because the link as is currently does not work on the website (https://agent-sandbox.sigs.k8s.io/docs/guides/jupyterlab/), by changing it to an actual link it ensures that the website sends you to the github link instead of https://agent-sandbox.sigs.k8s.io/docs/INSTALL.md (which it does now), this issue persists everywhere we have this.

Copy link
Contributor

@barney-s barney-s Dec 2, 2025

Choose a reason for hiding this comment

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

While this fixes the link on the rendered website, it makes the documentation less maintainable and potentially misleading for users on different versions. Pinning the link to the main branch means that anyone viewing this document from a tagged release will not see the corresponding version of the installation guide. We should investigate a solution within our static site generator to resolve these links correctly without hardcoding the branch.


### Access JupyterLab

Expand Down
2 changes: 1 addition & 1 deletion examples/langchain/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ kubectl version --client # kubectl 1.25+

### 1. Deploy Agent-Sandbox to Kind

You can find agent-sandbox setup instructions [here](../../README.md#installation).
You can find agent-sandbox setup instructions [here](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/README.md#installation).

```bash
# Verify installation
Expand Down