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

docs: Fix broken link to environment setup #1883

Merged
merged 1 commit into from
Nov 6, 2022

Conversation

trillium
Copy link
Contributor

@tancnle
Copy link
Collaborator

tancnle commented Nov 6, 2022

Thanks for your contribution @spiteless ❤️

FYI, we are using YARD to generate the documentation on the Rouge docs site. Ideally, it would be better the let the tool handle the parsing of the URLs in the markdown file, ie. using Yard Server. Unfortunately, our doc site is hosted in GitHub pages as a static site and hence these references must be absolute. I don't know if there is a better solution than your proposed changes so let's ship this 🚀

@tancnle tancnle merged commit 332cb6a into rouge-ruby:master Nov 6, 2022
@trillium
Copy link
Contributor Author

trillium commented Nov 6, 2022

I hear that. I looked elsewhere in this codebase and this was how it was done too.

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