web3.storage docs repo

This repository contains code and content for docs.web3.storage, the documentation site for the Web3.Storage service.

🚧 This docs site is still under construction, but you can preview our pre-launch work on Fleek at: https://web3-storage-docs.on.fleek.co/

You can find the code for the main web3.storage website and the underlying API here: https://github.com/web3-storage/web3.storage

For documentation authors:

Check this repo's issues page to see what items are in need of help, including content request issues looking for writers.
If you're writing something new, please read through the contribution guide for guidelines on types of content, grammar, formatting, and style.
For details on building the site locally and submitting pull requests, see the "For site developers" section below.

For site developers

Build and run locally

This site is built in Vuepress, and uses Vue/JavaScript for functional code and Markdown for post content.

To build a local copy, run the following:

Clone this repository:

git clone https://github.com/web3-storage/docs.git

Move into the docs folder and install the NPM dependencies:
```
cd docs
npm install
```
Boot up the application in dev mode:
```
npm start
```
Open localhost:8080 in your browser.
Close the local server with CTRL + c.
To restart the local server, run npm start from within the docs folder.

PR and preview

Once you're happy with your local changes, please make a PR against the main branch. Including detailed notes on your PR - particularly screenshots to depict any changes in UI - will help speed up approval and deployment.

All PRs against main automatically generate Fleek previews to make it easier to check your work. You can view your PR's preview by clicking Details in the fleek/build check at the bottom of your PR page:

Your preview URL will look something like this: https://<cid>.on.fleek.co (example: https://bafybeibwksog6le7t6anr4zenlcg2qntrmfznx6e64goree7hmzfsxcnl4.on.fleek.co/)

A reviewer will be by shortly to have a look!

Hosting / Deployment

We're using Fleek as the hosting and deployment platform. Auto deployments are enabled on the main branch and preview builds are generated when PRs are created merging to the main branch.

🔗 Links:

Production (main branch): https://web3-storage-docs.on.fleek.co/
Preview builds (see screenshot above): https://<cid>.on.fleek.co (example: https://bafybeibwksog6le7t6anr4zenlcg2qntrmfznx6e64goree7hmzfsxcnl4.on.fleek.co/)

Maintainers

This site's codebase is under active maintenance by members of the core team at Protocol Labs.

License

All software code is copyright (c) Protocol Labs, Inc. under the MIT license. Other written documentation and content is copyright (c) Protocol Labs, Inc. under the Creative Commons Attribution-Share-Alike License.

dchoi27/docs