Skip to content

Lowering content contribution threshold #613

@SamYuan1990

Description

@SamYuan1990

ref huggingface/diffusers#12032 (comment)

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

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

but in fact what open-in-colab means:

ref huggingface/diffusers#12032 (comment)

You can find the syntax on the doc-builder 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 #545 and huggingface/diffusers#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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions