ceramicnetwork / ceramicnetwork/js-ceramic
Update Ceramic documentation for non unix OSs
- Dominant language
- TypeScript
- Stars
- 423
- Forks
- 126
- PR merge metrics
- No merged PRs in 30d
Description
There are some differences based on the OS and shells devs are using.
For example, this is fine in MacOS:
```
ceramic create tile --content '{ "title": "My first Document 7" }'
```
But in Windows the command should look like:
```
ceramic create tile --content "{ \"title\": \"My first Document 7\" }"
```
Contributor guide
No contributing guide indexed for this repository
Research direction
Locate the documentation for the `ceramic create tile --content` command and review how shell quoting is currently explained. Add the macOS and Windows command forms shown in the issue, making the OS or shell distinction explicit; done means users on both systems can follow the example successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100