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

docs: refactor installation instructions #2060

Merged
merged 7 commits into from
Oct 24, 2024

Conversation

andrii-bodnar
Copy link
Contributor

@andrii-bodnar andrii-bodnar commented Oct 21, 2024

Description

This pull request aims to reduce user confusion in the Getting Started section of the website and put all installation and basic setup instructions in one place. This also makes the Getting Started section more framework/toolkit-agnostic.

A quick overview of the changes:

  • Added the new Installation and Setup page to the Getting Started section.
  • The Setup with React (React Project) page has been removed in favor of Installation and Setup.
  • The Setup with Vite (Vite Project) page has been removed in favor of Installation and Setup.
  • The installation instructions from other places (JavaScript guide, Macros) have also been moved to the Installation and Setup page (except the instructions for individual packages like CLI, SWC Plugin, etc.).
  • Other minor changes.

From the reader's perspective, the React Project and Vite Project were confusing since it's not clear why it was differentiated into React and Vite and it could lead to wrong assumptions or questioning all of this even more.

In general, it should reduce code duplication and make reading easier for the developer.

🖼️ Deployment Preview

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Examples update

Checklist

  • I have read the CONTRIBUTING and CODE_OF_CONDUCT docs
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)

Copy link

vercel bot commented Oct 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
js-lingui ✅ Ready (Inspect) Visit Preview Oct 23, 2024 7:40am

Copy link

github-actions bot commented Oct 21, 2024

size-limit report 📦

Path Size
./packages/core/dist/index.mjs 3.09 KB (0%)
./packages/detect-locale/dist/index.mjs 723 B (0%)
./packages/react/dist/index.mjs 1.65 KB (0%)
./packages/remote-loader/dist/index.mjs 7.26 KB (0%)

@timofei-iatsenko
Copy link
Collaborator

I'm reviewing thru reading docs on the deployment preview, will write down here a notes:

  • Lets remove "npm install --save-dev @babel/core" from installation for babel. I don't know why it needed.

  • Let's use the swc / babel tabs switch for Vite @vitejs/plugin-react / @vitejs/plugin-react-swc

  • Let's not advertise

    .linguirc file in JSON format.
    lingui section in package.json.

    instead, advertise only js or ts formats, for consistency.

I'm continuing reviewing

Copy link
Collaborator

@timofei-iatsenko timofei-iatsenko left a comment

Choose a reason for hiding this comment

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

The rest LGTM. THanks for update, that were a lot of duplications indeed.

@andrii-bodnar
Copy link
Contributor Author

@timofei-iatsenko thanks for the quick review. Just pushed the updated version.

@andrii-bodnar
Copy link
Contributor Author

I also think it would be nice to add Rspack and Webpack to the Build Tools section in the new article.

website/docs/installation.mdx Outdated Show resolved Hide resolved
website/docs/installation.mdx Outdated Show resolved Hide resolved
website/docs/installation.mdx Outdated Show resolved Hide resolved
website/docs/installation.mdx Outdated Show resolved Hide resolved
website/docs/ref/conf.md Outdated Show resolved Hide resolved
Co-authored-by: Vojtech Novak <vonovak@gmail.com>
@andrii-bodnar
Copy link
Contributor Author

@vonovak thanks for the review! I have updated everything according to your suggestions.

@andrii-bodnar andrii-bodnar removed the v5 label Oct 23, 2024
@andrii-bodnar andrii-bodnar added this to the v5 milestone Oct 23, 2024
@andrii-bodnar andrii-bodnar merged commit 68e5f1e into next Oct 24, 2024
9 of 10 checks passed
@andrii-bodnar andrii-bodnar deleted the docs/refactor-installation branch October 24, 2024 07:09
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