feature-sliced / documentation

🍰 Architectural design methodology for Frontend projects
https://feature-sliced.design
MIT License
1.4k stars 146 forks source link

docs: usage with NextJS article updated #644

Closed midas-png closed 6 months ago

midas-png commented 7 months ago

Background

I've faced a problem when starting developing a project using NextJS with FSD. Many time spent to get it right to combine NextJS and FSD to make it work together. There was no detailed article in the documentation of how it should work. So I decided to research the best practices of me and colleagues and describe in the article about using with NextJS

Changelog

  1. Usage with NextJS article was updated in russian and english
  2. sidebar_class_name: sidebar-item--wip was removed from .mdx files about usage with NextJS (in russian and english)

The WIP notification was left in the article as I think it should be updated by adding more useful links in the See also section

before:

Screenshots ![image](https://github.com/feature-sliced/documentation/assets/78198187/ea02edd4-a634-4ac8-b2a1-966b13b0c88d) ![image](https://github.com/feature-sliced/documentation/assets/78198187/fd4e73d3-6f71-4c83-93fd-0df7f3940703)

after:

Screenshots ![image](https://github.com/feature-sliced/documentation/assets/78198187/d06ca60b-eb2e-4271-b93e-ffcc66cfd0f2) ![image](https://github.com/feature-sliced/documentation/assets/78198187/1d02056c-a086-4317-a33c-9986d061d81f)
netlify[bot] commented 7 months ago

Deploy Preview for pr-fsd ready!

Name Link
Latest commit c48d346689f6a3b76c0370a9eb258a4d8c627474
Latest deploy log https://app.netlify.com/sites/pr-fsd/deploys/657f452b27d2b000084ee572
Deploy Preview https://deploy-preview-644--pr-fsd.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 configuration.

illright commented 7 months ago

Hi! This is great, I'm really glad someone actually took the time to write this up. As for the WIP status of this page, I personally think it's okay to mark this page as ready. The only thing I'd like to see are links to CodeSandbox or StackBlitz where a small version of Next is deployed along with the proposed structure, just to have something practical to look at. Could you add that please? Other than that, everything else is good

midas-png commented 7 months ago

Thanks! Sure, I'll take care of it

NazariiShvets commented 7 months ago

Thanks for your contrubition ❤️‍🔥 I believe you have done a great job 👍

I only have a problem with the `pages-flat' naming I feel that this naming has 2 problems:

1) It encourages you to structure your pages into a flat list. I would be happy if there was a mention of grouping somewhere so that users know how to structure pages if there are many of them

2) The name itself is quite ugly. Alternatives could be views or screens, but I have no experience with a nextjs project. It would be great if you could organize a poll within the community (like in the Telegram chat), collect their feedback on their choices and what names they use, and based on that response choose an appropriate name. If the community chooses pages-flat, it can be used

midas-png commented 6 months ago

I made a poll in the Telegram chat, but since many people use the App Router, I did not get a definite opinion on this issue. I left the option with views. Also, unfortunately, due to the high workload at work, I can't do the links to CodeSandbox now. I'm ready to deal with it later

midas-png commented 6 months ago

Сделал правки по комментариям. Поправил русскую и английскую версии. По главреду читаемость 9.5, в LanguageTool тоже проверил. Ссылки на route-groups удалил

midas-png commented 6 months ago

@illright Посмотрел, спасибо, изменения к месту