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

The docs and the starter project seem to disagree about putting everything in html tags in layouts. #10532

Closed
MikeMcDonald83 opened this issue Dec 27, 2024 · 6 comments
Labels
good first issue Good for newcomers help wanted Issues looking for someone to run with them! improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)

Comments

@MikeMcDonald83
Copy link

📚 Subject area/topic

layouts

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

https://docs.astro.build/en/basics/layouts/

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

In the docs about layouts, it says "However, if a layout component does contain a page shell, its element must be the parent of all other elements in the component. All <style> or <script> elements must be enclosed by the tags."

In the barebones project after 'npm create astro', the Layout.astro file has the style tag outside of the html tag. I don't know if this is actually inconsistent. Maybe the style tag is being used in a different way in the starter. I just noticed it while I was learning Astro.

(If this issue should have gone elsewhere, my bad.)

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

No response

@MikeMcDonald83 MikeMcDonald83 added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label Dec 27, 2024
@sarah11918
Copy link
Member

Thanks for bringing this up and I'll look into it! I know at one point we had a technical restriction that caused us to add that line to docs, but the basics template is brand new for v5 and maybe that restriction doesn't exist anymore?

@sarah11918
Copy link
Member

It does seem like this is not currently an issue, so I think the fix is to remove this sentence entirely from the Layouts page!

Will add help-wanted and good first issue and we would love a PR to remover this sentence/paragraph!

@sarah11918 sarah11918 added good first issue Good for newcomers help wanted Issues looking for someone to run with them! labels Jan 9, 2025
@jsparkdev
Copy link
Contributor

This issue has been resolved in #10690.

@MikeMcDonald83
Copy link
Author

Sorry if I was supposed to do something. I don't know much about PRs and stuff. Seems like it's resolved though. Thanks!

@sarah11918
Copy link
Member

No need to apologize @MikeMcDonald83 ! You did the right thing by reporting it, then the community can work together on a fix... which we did! All went perfectly as it should. 💜

@jsparkdev
Copy link
Contributor

Thank you all. This issue appears to be resolved, so I close it.

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 Issues looking for someone to run with them! improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)
Projects
None yet
Development

No branches or pull requests

3 participants