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.

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

Jump to bottom

**/README.md links don't work #388

Closed
klieret opened this issue May 21, 2024 · 2 comments · Fixed by #392
Closed

**/README.md links don't work #388

klieret opened this issue May 21, 2024 · 2 comments · Fixed by #392
Assignees
@klieret
Labels
📖 documentation Improvements or additions to documentation

Comments

@klieret
Copy link
Member

klieret commented May 21, 2024 •
edited
Loading

Local/relative links are now adapted to work for docs/**. The strategy of linking **/README.md into there unfortunately doesn't work with the links.

Probably the only way to avoid this confusion is to replace them with links to the online documentation.

See #384
@klieret klieret added the 📖 documentation Improvements or additions to documentation label May 21, 2024
@klieret klieret self-assigned this May 21, 2024
@klieret
Copy link
Member Author

klieret commented May 21, 2024

Would also avoid the link checker false positives.

@klieret
Copy link
Member Author

klieret commented May 21, 2024

Other option: Partial inclusion of markdown files and a warning notice (?)

@klieret klieret mentioned this issue May 22, 2024
Merged
klieret added a commit that referenced this issue May 22, 2024
@klieret
Doc: Replace symlinks with markdown files with links (#392)
9e0a597 
Closes #388
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@klieret klieret

Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Doc: Replace symlinks with markdown files with links princeton-nlp/SWE-agent
1 participant
@klieret