Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Readme for space-header #756

Merged
merged 4 commits into from
Jun 17, 2024
Merged

add Readme for space-header #756

merged 4 commits into from
Jun 17, 2024

Conversation

enzostvs
Copy link
Member

No description provided.

@enzostvs enzostvs requested a review from coyotte508 June 17, 2024 13:44
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@coyotte508
Copy link
Member

Thank you

Can you also:

  • Add yourself to the CODEOWNERS file for the space-headers package
  • Add the new README to docs/_toctree.yml - and gguf's one as well. Since it's linked from the main README, it needs to be linked or it will 404 in the doc published to https://huggingface.co/docs/huggingface.js/index

Thanks!

@enzostvs
Copy link
Member Author

@coyotte508 should be good! I was not sure about what to add for the gguf parser

@coyotte508
Copy link
Member

@enzostvs enzostvs merged commit 04daec0 into main Jun 17, 2024
6 checks passed
@enzostvs enzostvs deleted the core/readme-space-header branch June 17, 2024 15:02
Comment on lines +15 to +22
### Deno

```ts
// esm.sh
import { init } from "https://esm.sh/@huggingface/space-header"
// or npm:
import { init } from "npm:@huggingface/space-header"
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does it really make sense in Deno? it's not frontend no?

@@ -0,0 +1,59 @@
# 🤗 Hugging Face Space Header

A Typescript powered wrapper for the Space `mini_header` feature.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a screenshot of the header for readers to figure out what this is about?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and/or an example URL that uses it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants