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

Spelling error and unclear sentence in docs #805

Open
quentinkrammer opened this issue Jul 4, 2024 · 0 comments
Open

Spelling error and unclear sentence in docs #805

quentinkrammer opened this issue Jul 4, 2024 · 0 comments
Labels
good first issue Good for newcomers help wanted Looking for assistance on this issue improve documentation Enhance existing documentation.

Comments

@quentinkrammer
Copy link

quentinkrammer commented Jul 4, 2024

📚 Subject area/topic

/solid-start/building-your-application/static-assets.mdx

📋 Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/solid-start/building-your-application/static-assets#public-directory-versus-imports

📋 Description of content that is out-of-date or incorrect

If you want the links to your assets to update when they changes, the public directory is the best choice. This gives you full control over the url path to your assets and ensures that the links to your assets never change.

  • The "s" in "changes" should not be there.
  • The way the first sentence is structured it is ambiguous whether "they" refers to "links" or to "assets". (I guess you mean "assets" but in general I have a hard time understanding this, so not sure)
  • I also find the first sentence hard to make sense of. As far as I understand, asset links are totally stable when using the public directory. So why would links be updating. Isn't the whole point that links do NOT update when using the public directory?

Sry perhaps, I am just not understanding this.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

@quentinkrammer quentinkrammer added improve documentation Enhance existing documentation. pending review Awaiting review by team members. labels Jul 4, 2024
@LadyBluenotes LadyBluenotes added good first issue Good for newcomers help wanted Looking for assistance on this issue and removed pending review Awaiting review by team members. labels Jul 18, 2024
@LadyBluenotes LadyBluenotes removed their assignment Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Looking for assistance on this issue improve documentation Enhance existing documentation.
Projects
None yet
Development

No branches or pull requests

2 participants