Skip to content

docs: usage with NextJS article updated #644

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 14 commits into from
Dec 18, 2023
Merged

docs: usage with NextJS article updated #644

merged 14 commits into from
Dec 18, 2023

Conversation

midas-png
Copy link
Contributor

@midas-png midas-png commented Nov 26, 2023 •
edited by illright
Loading

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
image

after:

Screenshots

image
image

@netlify Netlify
Copy link

netlify bot commented Nov 26, 2023 •
edited
Loading

✅ Deploy Preview for pr-fsd ready!

Name Link
🔨 Latest commit c48d346
🔍 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
Copy link
Member

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
Copy link
Contributor Author

Thanks! Sure, I'll take care of it

@NazariiShvets
Copy link
Member

NazariiShvets commented Nov 28, 2023 •
edited
Loading

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 midas-png marked this pull request as draft November 28, 2023 20:16
midas-png and others added 2 commits November 28, 2023 23:22
@midas-png midas-png marked this pull request as ready for review December 6, 2023 22:37
@midas-png
Copy link
Contributor Author

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

illright
illright requested changes Dec 8, 2023
View reviewed changes
Copy link
Member

@illright illright left a comment

Choose a reason for hiding this comment

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

Не переживай насчет примеров, если загружен по работе — добавить всегда успеем, это не блокер для этого ПРа. Вчитался сейчас в текст, оставил несколько комментариев и предложений. Еще было бы клево пройтись по тексту через Главред (русский) и LanguageTool (английский), чтоб местами улучшить читаемость и отловить грамматические ошибки, если они имеются

@midas-png
Copy link
Contributor Author

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

@midas-png midas-png requested a review from illright December 13, 2023 20:19
illright
illright approved these changes Dec 17, 2023
View reviewed changes
Copy link
Member

@illright illright left a comment

Choose a reason for hiding this comment

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

@midas-png Я добавил небольшой моментик про проектные знания. Также я изменил путь импорта в одном месте и убрал остаточные пробелы. Посмотри, пожалуйста, скажи, что думаешь насчет этих изменений. С моей стороны никаких больше комментариев, можем вливать.

@midas-png
Copy link
Contributor Author

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

@illright illright merged commit df11d35 into feature-sliced:master Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@illright illright illright approved these changes

@NazariiShvets NazariiShvets Awaiting requested review from NazariiShvets

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@midas-png @illright @NazariiShvets
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy