https://github.com/pinatacloud/docs
The Official Pinata Documentation Repository
https://github.com/pinatacloud/docs
Last synced: 11 months ago
JSON representation
The Official Pinata Documentation Repository
- Host: GitHub
- URL: https://github.com/pinatacloud/docs
- Owner: PinataCloud
- Created: 2024-01-30T21:54:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-29T05:32:04.000Z (over 1 year ago)
- Last Synced: 2024-11-29T06:28:05.208Z (over 1 year ago)
- Language: MDX
- Homepage: https://docs.pinata.cloud
- Size: 10.2 MB
- Stars: 1
- Watchers: 3
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pinata Documentation
Welcome to the official repository for [docs.pinata.cloud](https://docs.pinata.cloud)! Contributions and edits are welcome, please keep the following guidelines in mind:
- Be respectful of other members and the Pinata team
- Refrain from making unhelpful edits (e.g. changing all the single quotes to double quotes, random punctuation, etc.). Contributions must be substantive and help improve the experience of the Pinata user.
- All edits must be submitted as pull requests and reviewed by the maintainers before merging into the main branch.
## Development
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
```
npm i -g mintlify
```
Run the following command at the root of your documentation (where mint.json is)
```
mintlify dev
```
## Publishing Changes
Submit a pull request with your changes and one of the Pinata Team maintainers will review and either request more edits or merge it into main.