Skip to content
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.

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

[Bug]: Fix Links in Documentation #1546

Closed
Yanni8 opened this issue Feb 5, 2024 · 7 comments
Closed

[Bug]: Fix Links in Documentation #1546

Yanni8 opened this issue Feb 5, 2024 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@Yanni8
Copy link
Contributor

Yanni8 commented Feb 5, 2024

Describe the bug

A lot of links in the documentation don't work. The cause of this is simple

The problem is that a refresh often adds an additional / at the end of the URL

I already mentioned this in the following pr #1449 (#1449 (comment))

But it seems like that the same issue also affects other urls for example: https://microsoft.github.io/autogen/docs/reference/agentchat/assistant_agent

Steps to reproduce

No response

Expected Behavior

No response

Screenshots and logs

No response

Additional Information

No response

@Yanni8 Yanni8 added the bug label Feb 5, 2024
@jackgerrits
Copy link
Member

The link https://microsoft.github.io/autogen/docs/reference/agentchat/assistant_agent works for me. My browser seems to automatically change it to: https://microsoft.github.io/autogen/docs/reference/agentchat/assistant_agent/

In what environment are you noticing this?

@Yanni8
Copy link
Contributor Author

Yanni8 commented Feb 5, 2024

The link https://microsoft.github.io/autogen/docs/reference/agentchat/assistant_agent works for me. My browser seems to automatically change it to: https://microsoft.github.io/autogen/docs/reference/agentchat/assistant_agent/
thats the probelm.

The link works fine. But some links on the page stoped working. For example klick on the ConversableAgent link

@sonichi
Copy link
Contributor

sonichi commented Feb 5, 2024

The link https://microsoft.github.io/autogen/docs/reference/agentchat/assistant_agent works for me. My browser seems to automatically change it to: https://microsoft.github.io/autogen/docs/reference/agentchat/assistant_agent/
thats the probelm.

The link works fine. But some links on the page stoped working. For example klick on the ConversableAgent link

This can be solved by using a link like [/docs/reference/agentchat/conversable_agent]

@sonichi sonichi added the documentation Improvements or additions to documentation label Feb 5, 2024
@jackgerrits
Copy link
Member

That conversable agent link is straight up broken. I think it is trying to be a cross reference but those seem to be not working well?

@jackgerrits
Copy link
Member

I had a go at integrating a tool to try and find these issues automatically but I am really not satisfied with the stability of it as a CI check #1547

@sonichi
Copy link
Contributor

sonichi commented Feb 6, 2024

We can replace all the relative paths with absolute path starting from /

@Yanni8
Copy link
Contributor Author

Yanni8 commented Feb 6, 2024

What would also work is to add a / to all links or prevent the server from automatically adding an extra / on refresh.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants