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

Add clearer instructions to experimental content intellisense setup #9122

Open
JusticeMatthew opened this issue Aug 16, 2024 · 2 comments
Open
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. good first issue Good for newcomers help wanted Issues looking for someone to run with them!

Comments

@JusticeMatthew
Copy link
Contributor

📚 Subject area/topic

content layer

📋 Suggested page

https://docs.astro.build/en/reference/configuration-reference/#experimentalcontentintellisense

📋 General description or bullet points (if proposing new content)

Provide clearer instructions for accessing and enabling the setting in VS Code

🖥️ Reproduction of code samples in StackBlitz

No response

@JusticeMatthew JusticeMatthew added the add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. label Aug 16, 2024
@JusticeMatthew JusticeMatthew changed the title Add clearer instructions to experimental content intellisense instructions Add clearer instructions to experimental content intellisense setup Aug 16, 2024
@sarah11918
Copy link
Member

sarah11918 commented Sep 9, 2024

Hey @JusticeMatthew - often with experimental features... you're on your own! 😅 This is a very new, and early feature. It's not yet ready for prime time, and it's at the stage where it's really just meant to be played with at your own risk to see how the feature will develop.

So we're not going to document more about using it right now, BUT, if you'd like to hunt down the original Astro implementation PR and update the reference entry with a link to it, so people can check out the code, see the initial discussion/thoughts behind the feature, I think that would be a great addition here! Something like:

See the [content Intellisense implementation PR](PR link) for more details about this early feature.

(Also noting that this change must be made in the Astro repo, not the docs repo directly, as source material that gets pulled in.)

@sarah11918 sarah11918 added good first issue Good for newcomers help wanted Issues looking for someone to run with them! labels Sep 9, 2024
@sarah11918
Copy link
Member

Just pointing out that this would be a good first issue for someone to add this link!

I think you could add the line mentioned above here and it would be helpful! https://github.com/withastro/astro/blob/7814a6cad15f06931f963580176d9b38aa7819f2/packages/astro/src/%40types/astro.ts#L2148

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. good first issue Good for newcomers help wanted Issues looking for someone to run with them!
Projects
None yet
Development

No branches or pull requests

2 participants