This repository manages the documentation for the Filecoin network. The content is built and hosted by GitBook. View the docs site at docs.filecoin.io.
Want to help out? Pull requests (PRs) are always welcome! If you want to help out but aren't sure where to start, check out the issues board.
Links are checked using lychee-action as configured by check-external-links.yml. Working links are required before merging. If you have a link that should be excluded from checking:
- wrap it in
`backticks`OR - wrap it in
<code>blocks OR - use
.lycheeignore
Found a problem with the Filecoin docs site? Please raise an issue. Be as specific and descriptive as possible; screenshots help!
You can view the backlog of issues, as well as what we're working on next, over on the project board
We use p tags to define the priority of an issue. The priority is defined by the docs team using the following definitions:
| Label | Impact | Due date | Example |
|---|---|---|---|
| P0 | Severely business-impacting | Same day. Drop everything and fix it immediately. | The website is down. |
| P1 | Business-impacting. | Within three days. | The API endpoint for a project is about to change. |
| P2 | Planned project request. | Within two weeks. | A new method will soon be added to a project API. |
| P3 | Suggestion or conceptual update. | No due date. | A blog post discussing the benefits of decentralization for web developers. |
| P4 | Deprioritized suggestions. These will not be addressed unless significant activity or community requests are received. | No due date. | Translate the docs into Klingon. |
Dual-licensed: MIT, Apache Software License v2, by way of the Permissive License Stack.