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

Update directory structure documentation #948

Merged
merged 2 commits into from
Feb 19, 2025

Conversation

wojtekn
Copy link
Contributor

@wojtekn wojtekn commented Feb 17, 2025

Related issues

Proposed Changes

  • I propose to add more details on the Studio directory structure.

Testing Instructions

Pre-merge Checklist

  • Have you checked for TypeScript, React or other console errors?

@wojtekn wojtekn requested a review from a team February 17, 2025 16:08
@wojtekn wojtekn self-assigned this Feb 17, 2025
Copy link
Contributor

@nightnei nightnei left a comment

Choose a reason for hiding this comment

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

LGTM 👍
I won't move in to "Reviewer approved", so that other team members could take a look ad say their objections, of they have.

Copy link
Contributor

@fredrikekelund fredrikekelund left a comment

Choose a reason for hiding this comment

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

LGTM with some small comments.

Should we use this opportunity to remove the ### CLI Development part from this doc? We don't officially support that stuff yet, so it seems confusing to include it in the docs.

Comment on lines +67 to +70
├── preview-site/ # Preview sites feature
│ ├── components/ # Feature-specific components
│ ├── hooks/ # Feature-specific hooks
│ └── lib/ # Feature-specific utilities
Copy link
Contributor

Choose a reason for hiding this comment

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

How do we deal with module specific Redux stores..? Have we discussed that?

I would keep everything in the src/stores folder, and I guess you could argue that this makes sense because Redux state is inherently global.

So, I'm OK with the structure as currently proposed, but still wanted to bring this up for discussion.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We decided to have only global Redux stores.

@wojtekn
Copy link
Contributor Author

wojtekn commented Feb 18, 2025

Should we use this opportunity to remove the ### CLI Development part from this doc? We don't officially support that stuff yet, so it seems confusing to include it in the docs.

It says it's only for development, so I don't see anything against keeping it there.

@wojtekn wojtekn merged commit c2f2baa into trunk Feb 19, 2025
8 of 9 checks passed
@wojtekn wojtekn deleted the update/directory-structure-docs branch February 19, 2025 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants