Skip to content

Document recommended setup and improve docs overall#8510

Merged
fisker merged 28 commits intoprettier:masterfrom
lydell:docs
Jun 28, 2020
Merged

Document recommended setup and improve docs overall#8510
fisker merged 28 commits intoprettier:masterfrom
lydell:docs

Conversation

@lydell
Copy link
Copy Markdown
Member

@lydell lydell commented Jun 6, 2020

Comment thread .prettierignore Outdated
Comment thread website/pages/en/index.js Outdated
Comment thread docs/install.md
Comment thread docs/install.md
Now, format all files with Prettier:

```bash
npx prettier@2.0.5 . --write
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I added this part about npx when I found out that that's how some people run Prettier on CI without installing it as a dependency (no idea why they do that though). Would be good to keep this remark somewhere.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

“some people” – who?

Isn’t it better that we promote the “correct way” (adding it to "devDependencies" in package.json)?

Otherwise we’ll have to say something like “if you want to do it the wrong way, here’s a slightly less wrong way to do it”

Copy link
Copy Markdown
Member

@thorn0 thorn0 Jun 14, 2020

Choose a reason for hiding this comment

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

Makes sense. By "some people" I meant those who complained that Prettier broke their CI when 2.0 was released, but now I haven't been able to find those complaints. Probably it's indeed not that important.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I added the “Note:” part here:

Screenshot 2020-06-18 at 07 15 15

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nicely put. The tabs look good too. Might look even better without the top border.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Removed borders and reduced padding:

Screenshot 2020-06-27 at 11 43 43

@lydell lydell marked this pull request as ready for review June 13, 2020 12:59
@lydell
Copy link
Copy Markdown
Member Author

lydell commented Jun 13, 2020

@kachkaev @j-f1 Would you mind taking a look at this (you’re both really good at writing and communication). Especially the Install page.

Copy link
Copy Markdown
Member

@j-f1 j-f1 left a comment

Choose a reason for hiding this comment

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

Looking good!

Comment thread docs/cli.md Outdated
Comment thread docs/cli.md Outdated
Comment thread docs/cli.md Outdated
Comment thread docs/cli.md Outdated
Comment thread docs/comparison.md
Comment thread docs/rationale.md Outdated
Comment thread docs/related-projects.md Outdated
Comment thread website/pages/en/index.js Outdated
Comment thread website/pages/en/index.js
Comment thread website/pages/en/index.js Outdated
Comment thread docs/install.md Outdated
Comment thread docs/install.md Outdated
Comment thread docs/install.md Outdated
Comment thread docs/install.md Outdated
@j-f1

This comment has been minimized.

@lydell
Copy link
Copy Markdown
Member Author

lydell commented Jun 27, 2020

Alright, all changes applied!

@fisker fisker merged commit 554b154 into prettier:master Jun 28, 2020
@lydell lydell deleted the docs branch June 28, 2020 07:53
@lydell lydell mentioned this pull request Jun 28, 2020
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jun 29, 2021
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.

Document that it's recommended to install Prettier locally Document recommended setup

5 participants