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] GettingStarted: Fix images and LLVM/MLIR contributing guide #6873

Merged
merged 2 commits into from
Mar 28, 2024

Conversation

ubfx
Copy link
Member

@ubfx ubfx commented Mar 27, 2024

No description provided.

@ubfx ubfx changed the title [Docs] Fix images and LLVM/MLIR contributing guide [Docs] GettingStarted: Fix images and LLVM/MLIR contributing guide Mar 27, 2024
Copy link
Contributor

@mikeurbach mikeurbach left a comment

Choose a reason for hiding this comment

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

😞 the issue with the links and images is known. It has been brought up before, for example here: #4343 (comment)

Basically, if we make the change in this PR, they'll work when viewed on GitHub, but will be broken on the actual website circt.llvm.org. No one has taken the time to figure out an approach that works in both scenarios.

The part about the LLVM/MLIR contribution process is great though, thanks for updating that. If you back out the changes to the links, we can merge that part.

If you're interested in figuring out how to specify the links in a way that works on both GitHub and the website, that would be great too, but the current change would break the website, which we want to keep working.

@ubfx ubfx force-pushed the getting-started-doc-fixes branch from 36c537a to 82e55fb Compare March 28, 2024 20:09
@ubfx
Copy link
Member Author

ubfx commented Mar 28, 2024

Ah, thanks for the explanation. I was wondering if I was missing something. I removed the image related changes from this PR but will take a look if I can figure out how to make this work with the website

@mikeurbach
Copy link
Contributor

Awesome, that sounds good to me.

@ubfx ubfx merged commit e1b437e into llvm:main Mar 28, 2024
4 checks passed
@ubfx ubfx deleted the getting-started-doc-fixes branch March 28, 2024 21:31
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