huggingface / huggingface/doc-builder

Lowering content contribution threshold

Open
#613 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
144
Forks
59
Avg merge
2d 5h
Merged PRs (30d)
13

Description

ref https://github.com/huggingface/diffusers/pull/12032#issuecomment-3157241595

Now we have may key words in document, some from language as markdown, html, latex. Some from specific tags defined in this repo.
So...

# Glossary for Reserved Words
we need a glossary for Reserved Words, what are those Reserved words, and where they come from.
from markdown? html? latex? Colab as tool?

for example in [document](https://github.com/huggingface/doc-builder?tab=readme-ov-file#writing-documentation-for-hugging-face-libraries)

```
add [[open-in-colab]] in the tutorial for which you want to build a notebook
```

but in fact what `open-in-colab` means:

ref https://github.com/huggingface/diffusers/pull/12032#issuecomment-3155731576

> You can find the syntax on the [doc-builder](https://github.com/huggingface/doc-builder?tab=readme-ov-file#writing-documentation-for-hugging-face-libraries) repo. For example, [[open-in-colab]] adds a button that opens a docs page in a Colab notebook so users can run it.

# Decouple full build from document

ref https://github.com/huggingface/doc-builder/issues/545 and https://github.com/huggingface/diffusers/pull/12032

Well, I deep dived into the reason why my build fails.

It turns out torch is missing and I am using python 3.13, after down grade python to 3.12... another compile error.

> just an example, for any CNCF document needs build for k8s or container runtime for document maintains as fix typo?

ref to our Philosophy

Usability over Performance
Simple over easy
contributor-friendly

I don't know if we as hugging face community treat document as code, and following code should self compilable. But.. with code design, we have interface to decouple components.

I hope community can considering Simplify document build process and make it contributor-friendly.

## Example

https://github.com/cncf/tag-env-sustainability/blob/main/tag-custom-dictionary-cspell.txt I know we can build a spell check list as same as it's becomes our Glossary and for quick check, just leave it to a common lint tool or spell check tool.

To ensure our document quality, we can have online preview build to check as [netlify](https://github.com/apps/netlify)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.