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

Lack of links to documents for download #36568

Open
xiaolinggnb opened this issue Oct 30, 2024 · 3 comments
Open

Lack of links to documents for download #36568

xiaolinggnb opened this issue Oct 30, 2024 · 3 comments
Labels
Content:Learn:CSS Learning area CSS docs

Comments

@xiaolinggnb
Copy link
Contributor

MDN URL

https://developer.mozilla.org/en-US/docs/Learn/CSS/CSS_layout/Grids

What specific section or headline is this issue about?

Nesting grids and subgrid

What information was incorrect, unhelpful, or incomplete?

The chapter does not provide the corresponding file download links and see it live section, 2 examples are not, which is a bit incongruous with the previous, although clicking on the sample code of the play can be found in the source code, I do not know whether there is an omission

What did you expect to see?

It is recommended to add the file download link and see it live content, in line with the previous documentation.

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

MDN metadata

Page report details
@xiaolinggnb xiaolinggnb added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Oct 30, 2024
@github-actions github-actions bot added the Content:Learn:CSS Learning area CSS docs label Oct 30, 2024
@xiaolinggnb
Copy link
Contributor Author

Like these 2 files, I copied the code from the Doc's play area, but not saw them on the github repo.
Grids.zip

@bsmth
Copy link
Member

bsmth commented Oct 30, 2024

Hi there, thanks for reporting. I think that's my fault, where I added the 'nesting' section in #28983, but I did not add the code to the learning area repository. Some context for this; you can hide some example code blocks on documentation pages like this:

```css
/* important for the context */
```

```html hidden
<!-- I don't want to show or repeat this -->
```

{{CSS & hidden HTML combined}}

If the reader wanted to see all code that makes the example work, they could view it in a GitHub repo which contained everything.

Since 2023, you can break out all live samples into the Playground, which has all code used to make the example work, including any code that is hidden on the documentation page (like these blocks).

So this is an authoring issue, we could mention opening the playground to see the full source instead of pointing to source on GitHub, but it would be good to be consistent on that. In general, we're trying to avoid maintaining copies of example code in multiple places now, so I don't think adding it to the learning area repo is in line with that.

Does that make sense?

@bsmth bsmth removed the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Oct 30, 2024
@xiaolinggnb
Copy link
Contributor Author

xiaolinggnb commented Oct 31, 2024

Yes, thank you for your answer—I completely understand now. Your documentation is great, especially in terms of reducing code maintenance and providing a playground to showcase the full code. So there’s no need to duplicate the hidden code in the documentation. I did review your docs carefully, and it seems there isn’t a prompt mentioning that the complete code can be viewed in the playground. Adding a hint might be helpful for beginners, though it's not a big issue. Again, thank you for your hard work.👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Learn:CSS Learning area CSS docs
Projects
None yet
Development

No branches or pull requests

2 participants