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

Updated documentation for upcoming VSCode extension release #288

Merged
merged 22 commits into from
Oct 29, 2024

Conversation

vinzbarbuto
Copy link
Collaborator

This PR aims to update the VSCode extension documentation to reflect the recent changes made to the extension (see this PR).

docs/assets/images/vs_code/error_message.svg Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
@axmmisaka
Copy link
Collaborator

axmmisaka commented Oct 21, 2024

Tried it locally, it's blurry but not that terrible if we use the same size/ppi:
图片

You can use a bigger-sized PNG:
图片

Or you can use this plugin which we enabled for our site, then inline the image. The documentation is garbage though.

import Image from '@theme/IdealImage';

{/* stuff in the middle  */}
import local_libraries from '../assets/images/vs_code/local_libraries.png';
<Image img={local_libraries} style={{maxWidth: 400}} />

The reason inline SVG looks better is that it inlines the style and additional metadata in the SVG, and stored a bigger PNG.

@vinzbarbuto
Copy link
Collaborator Author

vinzbarbuto commented Oct 21, 2024

Or you can use this plugin which we enabled for our site, then inline the image. The documentation is garbage though.

import Image from '@theme/IdealImage';

{/* stuff in the middle  */}
import local_libraries from '../assets/images/vs_code/local_libraries.png';
<Image img={local_libraries} style={{maxWidth: 400}} />

The reason inline SVG looks better is that it inlines the style and additional metadata in the SVG, and stored a bigger PNG.

Got it, thanks! I’ll use this plugin with PNGs instead of SVGs

@vinzbarbuto
Copy link
Collaborator Author

vinzbarbuto commented Oct 22, 2024

To-Do

  • Standardize the use of package instead of project
  • Rename the Create a new file section to Create a new package and include details on using lingo init to create an LF package from scratch

@axmmisaka
Copy link
Collaborator

Just a reminder, after you finish it would be nice to clean up the commits a little bit by squashing some of them

Copy link
Member

@lhstrh lhstrh left a comment

Choose a reason for hiding this comment

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

I think we're almost there. I added some more feedback and tried to give a more useful definition of "project."

docs/glossary/glossary.mdx Outdated Show resolved Hide resolved
docs/glossary/glossary.mdx Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/glossary/glossary.mdx Outdated Show resolved Hide resolved
docs/glossary/glossary.mdx Outdated Show resolved Hide resolved
docs/tools/code-extension.mdx Outdated Show resolved Hide resolved
docs/glossary/glossary.mdx Outdated Show resolved Hide resolved
docs/glossary/glossary.mdx Outdated Show resolved Hide resolved
@lhstrh lhstrh merged commit 1de4aff into lf-lang:main Oct 29, 2024
2 checks passed
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.

4 participants