Skip to content

Commit 0852231

Browse files
authoredApr 2, 2025··
Polish docs and add internal links (#2016)
* fix: name ipfs acronym on landing page * small polish --------- Co-authored-by: Daniel N <2color@users.noreply.github.com>
1 parent dc90eed commit 0852231

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed
 

‎docs/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: The home page for developer documentation for IPFS, the InterPlanet
55

66
# Welcome to the IPFS Docs
77

8-
IPFS is a set of building blocks for a better web. Open protocols to make your data smarter: content-addressed, verifiable, and unstoppable.
8+
The InterPlanetary File System (IPFS) is a set of building blocks for a better web. Open protocols to make your data smarter: content-addressed, verifiable, and unstoppable.
99

1010
On a more technical level, IPFS is a set of open protocols for addressing, routing, and transferring data on the web, built on the ideas of [content addressing](concepts/glossary.md#content-addressing) and peer-to-peer networking.
1111

@@ -28,6 +28,9 @@ Provide data to the IPFS network with IPFS Desktop or a pinning service:
2828

2929
- [Install IPFS Desktop which bundles an IPFS node (Kubo) and a UI to manage files, peers, and explore content on IPFS](./install/ipfs-desktop.md).
3030
- [Publish content to the IPFS network with IPFS Desktop](./how-to/desktop-app.md).
31+
32+
### Deploy static sites to the IPFS network
33+
3134
- [Deploy static sites to the IPFS network with a GitHub Action](./how-to/websites-on-ipfs/deploy-github-action.md).
3235

3336
### Build

‎docs/how-to/websites-on-ipfs/deploy-github-action.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ current-ipfs-cluster-version: v1.1.2
77

88
# Deploy Static Apps to IPFS with GitHub Actions
99

10-
This guide will walk you through the process of configuring a [GitHub Actions](https://docs.github.com/en/actions) workflow to deploy a repository containing a static site or app to IPFS using the [IPFS Deploy Action](https://github.com/ipfs/ipfs-deploy-action).
10+
This guide will walk you through the process of configuring a [GitHub Actions](https://docs.github.com/en/actions) workflow to deploy a repository containing a static site or app to IPFS using the [IPFS Deploy Action](https://github.com/ipshipyard/ipfs-deploy-action).
1111

1212
By the end of this guide, your web app (or just a static website) will be deployed to IPFS automatically when you push to your repository. It will also deploy pull request previews for each commit, and provide some other developer experience features, like commit status updates with the CID of the build, and a comment on pull requests with the IPFS CID and preview links.
1313

@@ -21,7 +21,7 @@ To see what this looks like in a real-world example, check out the [IPNS Inspect
2121

2222
## What is the IPFS Deploy Action?
2323

24-
The [IPFS Deploy Action](https://github.com/ipfs/ipfs-deploy-action) is a [composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action), that can be called as a step in a [GitHub Actions workflow](https://docs.github.com/en/actions/writing-workflows), and combines the following features:
24+
The [IPFS Deploy Action](https://github.com/ipshipyard/ipfs-deploy-action) is a [composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action), that can be called as a step in a [GitHub Actions workflow](https://docs.github.com/en/actions/writing-workflows), and combines the following features:
2525

2626
- 📦 Merkleizes your static site into a [CAR](../../concepts/glossary.md#car) file
2727
- 🚀 Uploads CAR file to either [Storacha](https://storacha.network/), [IPFS Cluster](https://ipfscluster.io/), or [Kubo](https://github.com/ipfs/kubo#readme)
@@ -300,5 +300,5 @@ This URL uses subdomain resolution (where the CID has its own subdomain), which
300300
If you encounter any issues:
301301

302302
1. Check the GitHub Actions run logs for detailed error messages
303-
2. Review the [action's README](https://github.com/ipfs/ipfs-deploy-action) for updates
304-
3. Open an issue in the [action's repository](https://github.com/ipfs/ipfs-deploy-action/issues/new) with detailed information about your setup and the problem you're experiencing
303+
2. Review the [action's README](https://github.com/ipshipyard/ipfs-deploy-action) for updates
304+
3. Open an issue in the [action's repository](https://github.com/ipshipyard/ipfs-deploy-action/issues/new) with detailed information about your setup and the problem you're experiencing

‎docs/install/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Anyone can use IPFS to store files in a _decentralized_ way. The easiest way to
1919

2020
If your browser doesn't support IPFS yet, you can install an IPFS companion extension that will let you view decentralized web content! [Learn more →](./ipfs-companion.md)
2121

22-
### Publish files with a pinning service
22+
### Deploy static sites to the IPFS network with a GitHub Action
2323

24-
Do you want to quickly and easily publish content with IPFS without complex tools? See the [Publish with IPFS quickstart](../quickstart/publish.md), where you'll learn how to use third-party pinning services to pin and provide files to the IPFS network.
24+
Do you want to quickly and easily automate the deployment of static websites to the IPFS network? See the [Deploy static sites to the IPFS network with GitHub Actions](../how-to/websites-on-ipfs/deploy-github-action.md), where you'll learn how to use [GitHub Actions](https://github.com/ipshipyard/ipfs-deploy-action) to automatically deploy static websites to the IPFS network.
2525

2626
## Infrastructure Tools
2727

@@ -43,7 +43,7 @@ If you need to run your own [delegated routing](../concepts/glossary.md#delegate
4343

4444
## Software Development
4545

46-
### Helia SDK for JS
46+
### Helia for TypeScript/JavaScript
4747

4848
[Helia](https://github.com/ipfs/helia) is a new implementation of IPFS in JavaScript that is designed to be more modular and lightweight than the [deprecated js-ipfs project](https://github.com/ipfs/js-ipfs).
4949

0 commit comments

Comments
 (0)
Please sign in to comment.