https://github.com/filecoin-project/filecoin-docs

Filecoin Docs
https://github.com/filecoin-project/filecoin-docs

documentation filecoin

Last synced: 3 months ago
JSON representation

Filecoin Docs

• Host: GitHub
• URL: https://github.com/filecoin-project/filecoin-docs
• Owner: filecoin-project
• Created: 2020-03-12T20:39:53.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-25T17:35:04.000Z (3 months ago)
• Last Synced: 2024-07-25T23:03:20.025Z (3 months ago)
• Topics: documentation, filecoin
• Language: Shell
• Homepage: https://docs.filecoin.io
• Size: 131 MB
• Stars: 217
• Watchers: 43
• Forks: 293
• Open Issues: 17
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• best-of-crypto - GitHub - 2% open · ⏱️ 04.06.2024): (Web 3.0)

README

        


    

[![MIT License](https://img.shields.io/badge/license-MIT-blueviolet?style=for-the-badge)](https://protocol.ai/blog/announcing-the-permissive-license-stack/)

[![Website status](https://img.shields.io/website.svg?style=for-the-badge&url=https%3A%2F%2Fdocs.filecoin.io)](https://docs.filecoin.io/)

[![Backlog](https://img.shields.io/badge/backlog-Updated-blue?style=for-the-badge)](https://github.com/orgs/filecoin-project/projects/103/views/1)

![Link Checker](https://img.shields.io/github/actions/workflow/status/filecoin-project/filecoin-docs/check-external-links.yml?style=for-the-badge&label=External%20link%20checker)


    

    

    



## Table of contents

- [About this repo](#about-this-repo)

- [Contributing](#contributing)

- [Issues](#issues)

    - [Backlog](#backlog)

    - [Priority](#priority)

- [License](#license)

## About this repo

This repository manages the documentation for the [Filecoin network](https://filecoin.io). The content is built and hosted by [GitBook](https://github.com). View the docs site at [docs.filecoin.io](https://docs.filecoin.io).

## Contributing

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](https://github.com/filecoin-project/filecoin-docs/issues).

## Issues 

Found a problem with the Filecoin docs site? [Please raise an issue](https://github.com/filecoin-project/filecoin-docs/issues/new). Be as specific and descriptive as possible; screenshots help!

### Backlog

You can view the backlog of issues, as well as what we're working on next, [over on the project board](https://github.com/orgs/filecoin-project/projects/103/views/1)

### Priority

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. |

## License

Dual-licensed: MIT, Apache Software License v2, by way of the [Permissive License Stack](https://protocol.ai/blog/announcing-the-permissive-license-stack/).