Add docs #13
Add docs #13
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. |
| secrets: | ||
| token: ${{ secrets.HUGGINGFACE_PUSH }} |
There was a problem hiding this comment.
@LysandreJik Can you help me set up this secret?
|
@mishig25 Do you know why the docs generated for this PR are blank (building locally works without any issues)? |
|
|
||
| Note that, unlike the built-in `open`, the mode in `fsspec`'s `open` defaults to binary mode, i.e. "rb". This means you must explicitly set encoding as "r"/"w" in case of text mode. | ||
|
|
||
| ## Integration |
There was a problem hiding this comment.
Maybe it'd make more sense to move the Integration section before the Usage section? It might be good for the user to check if they can use a URL with an integration before they start using the filesystem operations.
There was a problem hiding this comment.
This order comes from the s3fs docs, so I think I'll leave it as-is.
docs/source/index.mdx
Outdated
| {'repo_type': 'model', 'repo_id': 'johndoe/cityskapes', 'revision': 'dev', 'path/in/repo': ''} | ||
| ``` | ||
|
|
||
| ## Authentication |
There was a problem hiding this comment.
Maybe also move this under Integration so users know beforehand they should be logged in with their Hugging Face account. So:
## Integration
## Authentication
## Usage
Co-authored-by: Steven Liu <[email protected]>
Add docs