Skip to content

Commit e4c74b1

Browse files
committed
apply correct paths for internal md resolving
1 parent b117a35 commit e4c74b1

23 files changed

+53
-52
lines changed

CONTRIBUTING.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@
33
## Contributing to this documentation site
44

55
For guidelines on contributing to the [Filecoin Docs](https://github.com/filecoin-project/filecoin-docs) repository, please explore our documentation:
6-
- [Contribution tutorial](./docs/community/contribute/contribution-tutorial)
7-
- [Writing guide](./docs/community/contribute/writing-guide)
8-
- [Grammar, formatting, and style](./docs/community/contribute/grammar-formatting-and-style)
6+
7+
- [Contribution tutorial](./docs/community/contribute/contribution-tutorial.md)
8+
- [Writing guide](./docs/community/contribute/writing-guide.md)
9+
- [Grammar, formatting, and style](./docs/community/contribute/grammar-formatting-and-style.md)
910

1011
These guides are only concerned with documentation within this repository and does not contain any information regarding changes to VuePress or the HTML of the site. It also includes some general tips, tools, and workflows for creating helpful docs.
1112

1213
To learn how to host our VuePress site locally, see [README file](./README.md).
1314

1415
## Contributing to the Filecoin community
1516

16-
Looking for other ways to get involved? Read about the many [ways to contribute](./docs/community/contribute/ways-to-contribute) to the Filecoin community.
17+
Looking for other ways to get involved? Read about the many [ways to contribute](./docs/community/contribute/ways-to-contribute.md) to the Filecoin community.

docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ Available storage and pricing is not controlled by any single company. Instead,
1212

1313
There are many ways to participate in the Filecoin network, and several libraries, tools, products, and services to choose from:
1414

15-
- If you're new to web3 and Filecoin, we recommend checking out the resources in [this guide](/introduction/new-to-web3).
16-
- If you're a developer looking to get started building on Filecoin, check out the [Build section](/build/).
15+
- If you're new to web3 and Filecoin, we recommend checking out the resources in [this guide](/introduction/new-to-web3.md).
16+
- If you're a developer looking to get started building on Filecoin, check out the [Build section](./build/README.md).

docs/build/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,24 @@ Filecoin is for the builders. If you are excited about the potential of leveragi
99

1010
Read the resources in the **Start Building** section before you begin for helpful pointers on application architecture and networks to use when interacting and testing with Filecoin.
1111

12-
- [Interacting with the network](./start-building/interacting-with-the-network/)
12+
- [Interacting with the network](./start-building/interacting-with-the-network.md)
1313

1414
**Core Products** gives you an overview of the three main categories of products that we recommend to developers, and high-level pointers on how to run and integrate them in your application.
1515

16-
- **For most developers**, we recommend getting started with [Filecoin-backed IPFS Pinning Services](./core-products/filecoin-backed-pinning-services). This is especially true if you’re coming to Filecoin from IPFS or other web3 ecosystems.
17-
- **For some developers who want to manage their own nodes**, we recommend using [Powergate](./core-products/powergate).
18-
- **For very advanced, protocol-level developers**, we recommend using [Filecoin protocol implementations](./core-products/protocol-implementations), e.g. [lotus](https://lotu.sh).
16+
- **For most developers**, we recommend getting started with [Filecoin-backed IPFS Pinning Services](./core-products/filecoin-backed-pinning-services.md). This is especially true if you’re coming to Filecoin from IPFS or other web3 ecosystems.
17+
- **For some developers who want to manage their own nodes**, we recommend using [Powergate](./core-products/powergate.md).
18+
- **For very advanced, protocol-level developers**, we recommend using [Filecoin protocol implementations](./core-products/protocol-implementations.md), e.g. [lotus](https://lotu.sh).
1919

2020
**Developer Tools** provides brief descriptions and links to tools and libraries that provide important functionality for application developers.
2121

22-
- [Wallets, signing tools, and API clients](./developer-tools/wallets-signing-tools-api-clients/) and [Filecoin Community Resources](https://github.com/filecoin-project/docs/wiki#community-resources) will direct you to various resources you can use in your applications
22+
- [Wallets, signing tools, and API clients](./developer-tools/wallets-signing-tools-api-clients.md) and [Filecoin Community Resources](https://github.com/filecoin-project/docs/wiki#community-resources) will direct you to various resources you can use in your applications
2323
- The Filecoin [Component Design System](http://filecoin.onrender.com/) is a design system that includes Filecoin-branded web UI components and tutorials that you can integrate into your application.
2424

2525
**Examples** includes end-to-end code examples, tutorials, and walkthroughs for applications built on Filecoin. The examples section currently features:
2626

27-
- [Meme Marketplace](./examples/meme-marketplace/overview/): An example application built on Textile Hub, a Filecoin-backed IPFS Pinning Service.
28-
- [Simple Pinning Service](./examples/simple-pinning-service/overview/): An example application built on Powergate.
29-
- [Slate](./examples/slate/overview/): A production application built on Powergate.
30-
- [Network Inspector](./examples/network-inspector/overview/): An example application built on lotus.
27+
- [Meme Marketplace](./examples/meme-marketplace/overview.md): An example application built on Textile Hub, a Filecoin-backed IPFS Pinning Service.
28+
- [Simple Pinning Service](./examples/simple-pinning-service/overview.md): An example application built on Powergate.
29+
- [Slate](./examples/slate/overview.md): A production application built on Powergate.
30+
- [Network Inspector](./examples/network-inspector/overview.md): An example application built on lotus.
3131

3232
Please suggest any additional content that you would find useful using the links below.

docs/build/core-products/filecoin-backed-pinning-services.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ While each FPS provider will have slightly different instructions for utilizing
3737
This section will be updated with documentation links for additional FPS providers as they come online.
3838

3939
::: tip
40-
See a walkthrough of an end-to-end example application (the Meme Marketplace) built on Textile Buckets [here](../examples/meme-marketplace/overview/).
40+
See a walkthrough of an end-to-end example application (the Meme Marketplace) built on Textile Buckets [here](../examples/meme-marketplace/overview.md).
4141
:::
4242

4343
## How FPS solutions work

docs/build/core-products/powergate.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ From the [Textile docs](https://docs.textile.io/powergate/):
1818
> - Easily configure, connect, and deploy Powergate, [Lotus](https://lotu.sh), and [IPFS](https://ipfs.io) together.
1919
> - Much more!
2020
21-
**_Powergate is the recommended solution for developers who want an easier interface and better performance from Filecoin, but who prefer to manage their own nodes._** For most developers, we recommend using an [FPS](./filecoin-backed-pinning-services). For very low-level or advanced developers, you can integrate [lotus](https://lotu.sh) directly into your application.
21+
**_Powergate is the recommended solution for developers who want an easier interface and better performance from Filecoin, but who prefer to manage their own nodes._** For most developers, we recommend using an [FPS](./filecoin-backed-pinning-services.md). For very low-level or advanced developers, you can integrate [lotus](https://lotu.sh) directly into your application.
2222

23-
The Powergate project is built and maintained by Textile. You can see the full Powergate docs [here](https://docs.textile.io/powergate/).
23+
The Powergate project is built and maintained by Textile. You can see the full [Powergate docs](https://docs.textile.io/powergate/).
2424

2525
## How to use Powergate
2626

@@ -33,8 +33,8 @@ There are many ways to interact with the Powergate. These pathways are well-docu
3333
::: tip
3434
Sometimes the best way to learn is through examples.
3535

36-
- See a walkthrough of an example application (the Simple Pinning Service) built on the Powergate JS Client [here](../examples/simple-pinning-service/overview).
37-
- See a full production application (Slate) built on the Powergate JS Client [here](https://github.com/filecoin-project/slate/).
36+
- See a walkthrough of an example application (the Simple Pinning Service) built on the [Powergate JS Client](../examples/simple-pinning-service/overview.md).
37+
- See a full production application (Slate) built on the [Powergate JS Client](https://github.com/filecoin-project/slate/).
3838
:::
3939

4040
## How Powergate works

docs/build/core-products/protocol-implementations.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ Here is a snapshot of each implementation’s progress across the primary parts
2929

3030
✅ : fully featured implementation | 🔄 : reuses components from another implementation | 🔶 : partial implementation
3131

32-
**_We recommend that developers only build directly on Filecoin protocol implementations if they are very advanced developers or need to build at a very low level of the stack._** Filecoin protocol implementations expose low-level APIs that developers can use to integrate Filecoin directly into their applications. These APIs and their underlying functionality are still under heavy, active development, and require familiarity with blockchains and the Filecoin protocol. For most applications, we recommend developers use [FPS](./filecoin-backed-pinning-services) or [Powergate](./powergate).
32+
**_We recommend that developers only build directly on Filecoin protocol implementations if they are very advanced developers or need to build at a very low level of the stack._** Filecoin protocol implementations expose low-level APIs that developers can use to integrate Filecoin directly into their applications. These APIs and their underlying functionality are still under heavy, active development, and require familiarity with blockchains and the Filecoin protocol. For most applications, we recommend developers use [FPS](./filecoin-backed-pinning-services.md) or [Powergate](./powergate.md).
3333

3434
## How to use protocol implementations
3535

36-
Generally speaking, you can use a Filecoin protocol implementation as a “client” (user) or a “miner” (storage provider) _(see [What is Filecoin?](../../introduction/what-is-filecoin) for more)_. Most implementations separate out the storage miner functionality into a separate process from the core node functionality. The core node runs the blockchain system, makes storage and retrieval deals, performs data transfers, supports block producer logic, and syncs and validates the chain. The storage miner process produces sector commitments and _Proofs-of-Spacetime_ to prove they have been correctly storing storage client data, among other important functions. To be a Filecoin “client,” you need to run a full node. To be a Filecoin "miner," you must run a full node and the storage mining process.
36+
Generally speaking, you can use a Filecoin protocol implementation as a “client” (user) or a “miner” (storage provider) _(see [What is Filecoin?](../../introduction/what-is-filecoin.md) for more)_. Most implementations separate out the storage miner functionality into a separate process from the core node functionality. The core node runs the blockchain system, makes storage and retrieval deals, performs data transfers, supports block producer logic, and syncs and validates the chain. The storage miner process produces sector commitments and _Proofs-of-Spacetime_ to prove they have been correctly storing storage client data, among other important functions. To be a Filecoin “client,” you need to run a full node. To be a Filecoin "miner," you must run a full node and the storage mining process.
3737

3838
Each protocol implementation can be run and integrated in a few different ways:
3939

@@ -46,10 +46,10 @@ If interacting with the implementation’s RPC APIs, the general development pat
4646
- Run a Filecoin node locally (e.g. run lotus locally) and have the application make RPC API requests to the local node.
4747
- Run a Filecoin node remotely (e.g. in the cloud) and have the application make RPC API requests to the remote node.
4848

49-
Filecoin protocol implementations provide access to core Filecoin protocol workflows, with very few abstractions of the core concepts. This can be very useful, as it allows flexibility and precision in interacting with Filecoin network functionality. However, integrating nodes directly can require greater familiarity with how Filecoin works. To learn more about the various workflows enabled by the core Filecoin protocol, check-out the [How-tos](../../how-to).
49+
Filecoin protocol implementations provide access to core Filecoin protocol workflows, with very few abstractions of the core concepts. This can be very useful, as it allows flexibility and precision in interacting with Filecoin network functionality. However, integrating nodes directly can require greater familiarity with how Filecoin works. To learn more about the various workflows enabled by the core Filecoin protocol, check-out the [How-tos](../../how-to/README.md).
5050

5151
::: tip
52-
See a walkthrough of an end-to-end example application (the Filecoin Network Inspector) built using [Lotus’ JS API client](../examples/network-inspector/overview).
52+
See a walkthrough of an end-to-end example application (the Filecoin Network Inspector) built using [Lotus’ JS API client](../examples/network-inspector/overview.md).
5353
:::
5454

5555
## Resources

docs/build/examples/meme-marketplace/overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: A brief description of the Meme Marketplace Example.
55

66
# Overview
77

8-
In this tutorial, we will build a meme marketplace using [Textile Hub](https://docs.textile.io/hub/), which is a [Filecoin-backed IPFS Pinning Service](../../core-products/filecoin-backed-pinning-services), and Ethereum ERC 721 standard.
8+
In this tutorial, we will build a meme marketplace using [Textile Hub](https://docs.textile.io/hub/), which is a [Filecoin-backed IPFS Pinning Service](../../core-products/filecoin-backed-pinning-services.md), and Ethereum ERC 721 standard.
99

1010
You will be able to upload memes to Textile Hub using a dashboard and register the memes with ERC 721 Non-fungible tokens, which will help anyone to uniquely identify the memes and their owners in a decentralized way!
1111

docs/build/examples/sample-architectures.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ description: Learn how you might build an app on top of Filecoin.
77

88
No matter what you wish to build on Filecoin, you'll generally need a few basic elements:
99

10-
- **A node.** Each Filecoin-based service or application will need to use at least one Filecoin node that maintains consensus. All interactions with the network must flow through an up-to-date node: sending and receiving market deals, sending and receiving data, and more. You can host this yourself, or choose a [hosted node](../start-building/interacting-with-the-network/) option.
11-
- **An API.** Depending on language, and your preference for more granular or high-level commands, you can either directly use the node's go RPC API, or use one of the available [JS API client libraries](../developer-tools/wallets-signing-tools-api-clients/#api-clients).
10+
- **A node.** Each Filecoin-based service or application will need to use at least one Filecoin node that maintains consensus. All interactions with the network must flow through an up-to-date node: sending and receiving market deals, sending and receiving data, and more. You can host this yourself, or choose a [hosted node](../start-building/interacting-with-the-network.md) option.
11+
- **An API.** Depending on language, and your preference for more granular or high-level commands, you can either directly use the node's go RPC API, or use one of the available [JS API client libraries](../developer-tools/wallets-signing-tools-api-clients.md#api-clients.md).
1212
- Optional: Additional helper tools and libraries to simplify functions such as storage commands, managing deals, and more.
1313

1414
### Examples

docs/build/examples/simple-pinning-service/overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: A brief description of the Simple Pinning Service Example.
55

66
# Overview
77

8-
In this tutorial, we will build a simple pinning service using [Powergate](../../core-products/powergate).
8+
In this tutorial, we will build a simple pinning service using [Powergate](../../core-products/powergate.md).
99

1010
A pinning service is a remote service that helps you manage your data (like a decentralized Google Drive). In this tutorial's context, the data will be managed on Filecoin & IPFS.
1111

docs/community/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Filecoin is home to a vibrant, diverse community of thousands of contributors an
99

1010
## Ways to contribute
1111

12-
No matter your area of specialty or level of expertise, there are many [ways to contribute](./contribute/ways-to-contribute/) to Filecoin and make a real difference in the Filecoin community at large.
12+
No matter your area of specialty or level of expertise, there are many [ways to contribute](./contribute/ways-to-contribute.md) to Filecoin and make a real difference in the Filecoin community at large.
1313

1414
## Filecoin forums
1515

@@ -25,4 +25,4 @@ ProtoSchool isn't just home to interactive tutorials on DWeb topics — it's als
2525

2626
## Social media
2727

28-
We're in a lot of places. Here's [how to find them all](social-media/social-media) for your favorite platforms.
28+
We're in a lot of places. Here's [how to find them all](social-media/social-media.md) for your favorite platforms.

docs/community/contribute/contribution-tutorial.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Contribute to Filecoin documentation by finding issues, fixing them
55

66
# Contribution tutorial
77

8-
While the [grammar, formatting, and style](./grammar-formatting-and-style) and the [writing guide](./writing-guide) can both help you write excellent content for the Filecoin Docs project, they don't delve into how you can actually submit you content changes. This guide will walk you through finding an issue, fixing it, and then submitting your fix to the `filecoin-project/filecoin-docs` project.
8+
While the [grammar, formatting, and style](./grammar-formatting-and-style.md) and the [writing guide](./writing-guide.md) can both help you write excellent content for the Filecoin Docs project, they don't delve into how you can actually submit you content changes. This guide will walk you through finding an issue, fixing it, and then submitting your fix to the `filecoin-project/filecoin-docs` project.
99

1010
There are plenty of small-sized issues around Filecoin documentation that make for easy, helpful contributions to the Filecoin project. Here, we'll walk through:
1111

docs/community/contribute/grammar-formatting-and-style.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn the syntax and formatting rules for writing documentation for
55

66
# Grammar, formatting, and style
77

8-
This page details the syntax and formatting rules for writing Filecoin documentation. For more conceptual ideas of writing, check out the [writing guide](./writing-guide).
8+
This page details the syntax and formatting rules for writing Filecoin documentation. For more conceptual ideas of writing, check out the [writing guide](./writing-guide.md).
99

1010
## Grammar and spelling
1111

docs/community/contribute/ways-to-contribute.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ Filecoin is a huge project and undertaking, and with lots of code comes the need
3030

3131
Before contributing to the Filecoin docs, please read these quick guides; they'll save you time and help keep the docs accurate and consistent!
3232

33-
1. [Style and formatting guide](./grammar-formatting-and-style)
34-
2. [Writing guide](./writing-guide)
33+
1. [Style and formatting guide](./grammar-formatting-and-style.md)
34+
2. [Writing guide](./writing-guide.md)
3535

36-
If you have never contributed to an open-source project before, or just need a refresher, take a look at the [contribution tutorial](./contribution-tutorial).
36+
If you have never contributed to an open-source project before, or just need a refresher, take a look at the [contribution tutorial](./contribution-tutorial.md).
3737

3838
### Community
3939

40-
If interacting with people is your favorite thing to do in this world, join the [Filecoin chat and discussion forums](../chat-and-discussion-forums) to say hello, meet others who share your goals, and connect with other members of the community.
40+
If interacting with people is your favorite thing to do in this world, join the [Filecoin chat and discussion forums](../chat-and-discussion-forums.md) to say hello, meet others who share your goals, and connect with other members of the community.
4141

4242
### Build Applications
4343

0 commit comments

Comments
 (0)