This repository has been archived by the owner on Apr 29, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #100 from ipfs/feature/edit-readme
Spruce up Readme
- Loading branch information
Showing
1 changed file
with
11 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,21 @@ | ||
# IPFS - FAQ | ||
|
||
This is the IPFS FAQ page. Please ask your question in an [Issue](https://github.com/ipfs/faq/issues). Make sure to search, as your question may already have been answered. | ||
|
||
Useful Links: | ||
### - [View Questions + Answers](https://github.com/ipfs/faq/issues) | ||
### - [Ask a new Question](https://github.com/ipfs/faq/issues/new) (please search first!) | ||
Please ask your question in an [Issue](https://github.com/ipfs/faq/issues). Make sure to search existing issues, as your question may already have been asked and answered. | ||
|
||
### [View Questions + Answers](https://github.com/ipfs/faq/issues) | ||
### [Ask a new Question](https://github.com/ipfs/faq/issues/new) | ||
_Please search first!_ | ||
|
||
## Notes: | ||
|
||
#### Rendering to a page | ||
#### Comment! | ||
|
||
All these questions and answers will be compiled into a webpage rendered at http://ipfs.io/docs/install (still TODO) | ||
There are a lot of questions, and it is difficult for the IPFS team to go through the backlog and refine answers for older questions. If you think a question hasn't been answered adequately, comment on it, and we'll look at it. Unlike on the rest of GitHub, using :thumb: or '+1' is actively encouraged as a way to show that a question should be brought back to our attention. | ||
|
||
#### use "WIP" in the question title to denote a "Work In Progress" answer. | ||
#### Use "WIP" in the question title to denote a "Work In Progress" answer. | ||
|
||
Let's mark any Q/As with `WIP` when the answer is long, complex, and likely to evolve over time. It is very important to signal when we think something is roughly "a final answer", versus "a place to jot down notes and point others for quick disambiguation". Many answers, like comparisons to other systems, will be WIPs for a while. | ||
|
||
#### Rendering to a page | ||
|
||
All these questions and answers will be compiled into a webpage rendered at http://ipfs.io/docs/install (still TODO) |