added docs for init and lint commands #156
Conversation
| $ rome init | ||
| ``` | ||
|
|
||
| Following this `rome` will ask you, whether you want to use the default setup or customize your project further. |
|
|
||
| If you choose `yes`, it will create a default configuration file `rome.json` that looks like this: | ||
|
|
There was a problem hiding this comment.
Whenever you're talking about something Rome does at the beginning of a new section, use rome, not "it"
Also, you can surround rome.json with commas
| ? Project name: | ||
| ``` | ||
|
|
||
| After this you have again a choice whether you want to enable linting and formatting. |
There was a problem hiding this comment.
You can remove again
Add "of" between "a choice" and "whether"
There was a problem hiding this comment.
Add instructions on how to navigate up and down between options since the CLI does not provide that information
|
|
||
| ### `lint` | ||
|
|
||
| The `lint` command lets romes linter check your project files for problems. If no arguments are given, the entire project will be included. |
There was a problem hiding this comment.
I think you can simplify this:
The lint command checks your project files for code problems, such as unused variables. If no arguments are given, the entire project will be included.
|
|
||
| #### Interpreting the result | ||
|
|
||
| If everything was fine, you'll get the a result like this: |
There was a problem hiding this comment.
It's best to be specific, so instead of "everything was fine," say something like "If Rome did not detect any problems"
| ℹ Add "type": "module" to your package.json | ||
| ``` | ||
|
|
||
| Those messages contain the following sections: |
| description: Detailed description of the available commands. | ||
| --- | ||
|
|
||
| ## Commands |
There was a problem hiding this comment.
Docusaurus will put a Commands header for you so you don't need this. As a result, all of the level three headers should be level two, and all the level four headers should be level three.
|
Not sure if we want to have a separate sidebar category for commands, with a page for each command - I think this is probably fine for now, we can always break it up later. |
|
@rzig I included your suggestions into the documentation. Thank you very much :) |
|
Nice! This is great! The |
|
@MareikeTaeubner can you test the commands on the latest master and see if there are any differences in output and update your PR so that it gets merged. Otherwise, your PR looks great! |
|
I removed the |
|
Thank you! Sorry for the delay in merging. Would love to have you involved in the Discord, we have the channel #contributors-website for website/docs discussion. |
Added 'How to use' documentation for
initandlintto the website.Contributes to #105
I'm not a native English speaker, please correct me, if something sounds wrong ^^"