Revisit documentation part 1: divio-like landing page, installation page, configuration page #1233
Conversation
|
The documentation is not available anymore as the PR was closed or merged. |
There was a problem hiding this comment.
Nice refactor! cc @stevhliu, who has done a similar work across our other libraries in the past.
I'm not convinced about the empty sections to be populated later; I'd rather this PR focused on an initial refactoring, and for these sections to appear once they're being populated
docs/source/concepts/overview.mdx
Outdated
| # Concepts | ||
|
|
||
| In this section, you will find high-level explanations for building a better understanding | ||
| of important topics such as the philosophy behind `huggingface_hub`, the git-based vs http-based | ||
| paradigm or the cache system internals. | ||
|
|
||
| This section is currently empty but will get populated soon. |
There was a problem hiding this comment.
Are you sure about adding a new empty page to be populated later? I would add it when there is an actual need to reduce the noise
There was a problem hiding this comment.
I agree it may be better to leave the "coming soon" docs out for now until they're ready. In addition to noise, it also creates expectations from users, and when the new doc isn't published soon some users may be disappointed.
There was a problem hiding this comment.
I get your point. I removed them in dd95492.
docs/source/configuration.mdx
Outdated
| @@ -0,0 +1,133 @@ | |||
| # Configuration | |||
There was a problem hiding this comment.
Maybe name it environment_variables as this page is focused solely on that?
There was a problem hiding this comment.
Otherwise I would expect this page to also contain info about stuff such as lfs-enable-largefiles which is also part of the "Configuration" but out of scope for this specific reference
There was a problem hiding this comment.
Great job documenting all these environment variables!
I'd consider moving this page to the Reference section, mention a few of the most important (or common) ones on the Installation page, and linking to the rest of them. While this is useful info, I don't think it is necessarily important for the majority of users who are getting started.
There was a problem hiding this comment.
I moved the configuration page to package_references/environment_variables in 7c145cf. Thanks for the feedback !
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
|
Thanks a lot @LysandreJik and @stevhliu for the feedback ! I integrated all of your comments. They helped a lot 👍 👍 |
docs/source/configuration.mdx
Outdated
|
|
||
| ### HF_ENDPOINT | ||
|
|
||
| To configure the 🤗 Hub base url. You might want to set this variable if your organization |
There was a problem hiding this comment.
Maybe mention what is the base url or what it is used for
docs/source/configuration.mdx
Outdated
| a HTTP request to check that a new version is not available. Setting `HF_HUB_OFFLINE=1` will | ||
| skip this call which speeds up your loading time. | ||
|
|
||
| ### HF_HUB_DISABLE_IMPLICIT_TOKEN |
There was a problem hiding this comment.
Do we really want to document publicly all environment variables? That might make it harder to disable env variables, specially for the ones that are more intended to be for internal use cases.
First PR to revisit a bit the documentation. Goal is to invest some time in revisiting the documentation but to still make those changes incrementally. See #1226 for a more exhaustive list of what can be planned/what is planned to be improved "at some point".
PR includes:
guides/tutorials/concepts/referencesfolders and section. Currently some are empty. Existing guides have been kept in the same place to avoid breaking urlshuggingface_hub