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

FR: Better Docs, Structure Explained #3

Open
kerns opened this issue Feb 9, 2023 · 0 comments
Open

FR: Better Docs, Structure Explained #3

kerns opened this issue Feb 9, 2023 · 0 comments

Comments

@kerns
Copy link

kerns commented Feb 9, 2023

Love that this project exists... it's exactly what I wanted in terms of being bare bones, with just Tailwind + Sanity + Editing Previews. However the structure, to my mind, is a little confusing.

I wish it was more obvious as to where global components should go, and how to work with this setup to build out a site on this structure in a performant, correct way. I think it's great that it's not too opinionated, but it does have opinions :) How best to work with those and build on top of them could just be better explained IMO. Something in the README would be fine.

Like, a "Hello World" instead of a <pre>{JSON.stringify(data, null, 2)}</pre> might also clue more of the audience in. And is it a good idea to have a folder named /Pagewhen of course Next uses /Pages. The names of the files also seem, less than ideal.

Screenshot 2023-02-09 at 19 46 46

But, yeah, I could totally be convinced! Just love to start a discussion, and find out if it's just me or if the semantics and docs might actually be improved.

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

No branches or pull requests

1 participant