align image paths in lsif/overview.md

microsoft / language-server-protocol

Defines a common protocol for language servers.

https://microsoft.github.io/language-server-protocol/

Creative Commons Attribution 4.0 International

10.95k stars 766 forks source link

align image paths in lsif/overview.md #1832

Closed patmejia closed 8 months ago

patmejia commented 9 months ago

align image paths in `lsif/overview.md`

update non-functional image links within lsif/overview.md.
align paths for hover.png, hoverResult.png, foldingRange.png.

Compliance: This pull request adheres to Microsoft's Open Source Code of Conduct.

dbaeumer commented 8 months ago

@patmejia this change will break the rendering of the images.

Can you explain what your thinking behind this is.

patmejia commented 8 months ago

@dbaeumer, thanks for the review.

understood that my pr could break image rendering. i see the project likely uses a static site generator (i.e. Liquid templating syntax ({{ "/overviews/lsp/overview" | prepend: site.baseurl }}), affecting how paths are resolved.

likewise, #1833

should i revert these changes or is there another fix you recommend?

dbaeumer commented 8 months ago

Since all images are rendered correctly I am actually not understanding what you want to fix / achieve. Could you please explain this.

patmejia commented 8 months ago

agree with observation.