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 frequently asked questions in documentation #34252

Merged
merged 18 commits into from
Feb 12, 2022
Merged

Update frequently asked questions in documentation #34252

merged 18 commits into from
Feb 12, 2022

Conversation

Nutlope
Copy link
Contributor

@Nutlope Nutlope commented Feb 12, 2022

This is a rewrite of the FAQ section as it's quite outdated. Thank you to @styfle and @leerob for the suggestions.

Here's a list of changes I've made:

  • Removed “How big is it”
  • Removed “What syntactic features are compiled? How do I change them?”
  • Replaced all occurances of "it" with "Next.js"
  • Changed "Is Next.js production ready?" to mention showcase
  • Started the answer to each question with either yes or no for yes/no questions
  • Listed more pros for router section, changed question name, and backlined to migrating from react router docs
  • Revamped "fetching data" answer to list all our data fetching methods and backlink to docs
  • Made "Can I use Next.js with my favorite JavaScript library?" more clear and emphasized the large number of examples we have
  • Reorganized questions to make more sense
  • Made wording more consistent throughout

Additional Questions:

  1. Do we want to keep the "What inspired Next.js" section the same? One option could be to only keep the first sentence linking to G's article and not talk about PHP because of its reputation among newer web developers as an old & outdated technology.
  2. What's the advantage of routes always being lazy-loadable? I'd like to add this to the last bullet point of the new router question to make it obvious what the benefit is.

docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
Nutlope and others added 7 commits February 11, 2022 21:43
Co-authored-by: JJ Kasper <[email protected]>
Co-authored-by: JJ Kasper <[email protected]>
Co-authored-by: JJ Kasper <[email protected]>
Co-authored-by: JJ Kasper <[email protected]>
Co-authored-by: JJ Kasper <[email protected]>
Co-authored-by: JJ Kasper <[email protected]>
Co-authored-by: JJ Kasper <[email protected]>
@Nutlope Nutlope requested a review from ijjk February 12, 2022 02:44
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
Nutlope and others added 6 commits February 12, 2022 13:29
Co-authored-by: Steven <[email protected]>
Co-authored-by: Steven <[email protected]>
Co-authored-by: Steven <[email protected]>
Co-authored-by: Steven <[email protected]>
Co-authored-by: Steven <[email protected]>
Co-authored-by: Steven <[email protected]>
@Nutlope Nutlope requested a review from styfle February 12, 2022 18:30
docs/faq.md Outdated Show resolved Hide resolved
Co-authored-by: JJ Kasper <[email protected]>
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
Copy link
Member

@leerob leerob left a comment

Choose a reason for hiding this comment

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

Excellent incremental updates, thank you!

@leerob leerob changed the title Rewrite of faq section Update frequently asked questions in documentation Feb 12, 2022
@kodiakhq kodiakhq bot merged commit d5c815e into canary Feb 12, 2022
@kodiakhq kodiakhq bot deleted the new-faq branch February 12, 2022 21:24
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants