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 feature directories to project structure guide #3237

Merged
merged 11 commits into from
May 15, 2023

Conversation

TheOtterlord
Copy link
Member

What kind of changes does this PR include?

  • New or updated content

Description

@netlify
Copy link

netlify bot commented May 12, 2023

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit aad2b6b
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/64626905dc216800083e770e
😎 Deploy Preview https://deploy-preview-3237--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@sarah11918
Copy link
Member

Good call, @TheOtterlord! I'm wondering what we should call these directories. We might refer to them as "reserved" directories internally (as opposed to "feature" directories) because that also conveys that you can't have these folders yourself for other things... they really are reserved in Astro.

@sarah11918 sarah11918 added the add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. label May 12, 2023
@sarah11918
Copy link
Member

Also, I'd be tempted to put these up with the other folders, and just say in each folder that it's reserved, vs a special section, I think? Just a first thought.

@TheOtterlord
Copy link
Member Author

Yep! I like that.

I struggled between "Reserved" and "Features" because I don't think src/assets is exactly reserved? But we are trying to get across the fact that these are things you probably shouldn't use unless you use them their intended way. So specifying it in each directory's text should be plenty.

TheOtterlord and others added 2 commits May 15, 2023 11:59
Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Thanks, @TheOtterlord! I've made some suggestions here, and again, I think we should move these up to where the other folders are explained. I don't think this should be a separate category, but rather, these folders should occur in alphabetical order on the page.

So, I would put src/assets/ right after src/ and I would put src/content/ after src/components/. Leave each folder itself to describe what it does, whether it's reserved etc.

I'm not sure why a bunch of checks are failing (could be a fluke!) but let's get this content in the right spot, then figure that out! 😄

src/content/docs/en/core-concepts/project-structure.mdx Outdated Show resolved Hide resolved
src/content/docs/en/core-concepts/project-structure.mdx Outdated Show resolved Hide resolved
src/content/docs/en/core-concepts/project-structure.mdx Outdated Show resolved Hide resolved
src/content/docs/en/core-concepts/project-structure.mdx Outdated Show resolved Hide resolved
TheOtterlord and others added 2 commits May 15, 2023 12:23
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@TheOtterlord
Copy link
Member Author

Seems the CI fixed itself :D

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Looking great now, I think! The src/assets/ content was just moved a little too high up, so I brought it back down. And, I threw the word "reserved" into src/content/, but I think with these changes, we're good to go! 🙌

src/content/docs/en/core-concepts/project-structure.mdx Outdated Show resolved Hide resolved
src/content/docs/en/core-concepts/project-structure.mdx Outdated Show resolved Hide resolved
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@sarah11918
Copy link
Member

D'oh! I realized that while I ALWAYS refer to folders with a trailing slash... none of the other sidebar entries do. 😅 So, I'll just quickly revert those for consistency, then I'll get you in the "update branch" queue and merged! 🎉

@sarah11918 sarah11918 merged commit 8104a41 into withastro:main May 15, 2023
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add src/content/ to project structure guide
3 participants