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

GitHub workflows & toctree #14

Merged
merged 10 commits into from
Feb 1, 2024
Merged

Conversation

MKhalusova
Copy link
Contributor

@MKhalusova MKhalusova commented Jan 29, 2024

The PR adds

  • the GitHub workflows needed to build the cookbook under hf.co/learn and to preview PRs.
  • _toctree.yml

@MKhalusova
Copy link
Contributor Author

@mishig25 Should I also move the notebook files under notebooks/en instead of them being under notebooks?

@mishig25
Copy link
Collaborator

@mishig25 Should I also move the notebook files under notebooks/en instead of them being under notebooks?

yes if we expect there is gonna be translations

@MKhalusova
Copy link
Contributor Author

Moved the notebooks

@MKhalusova
Copy link
Contributor Author

@mishig25 I added a _toctree.yaml. Two questions

  • Should I leave the .ipynb or remove it? For .mdx files we don't specify it.
  • I want to add an index page. Is it ok to have it as a .mdx file?

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@MKhalusova MKhalusova changed the title Added GitHub workflows GitHub workflows & toctree Jan 29, 2024
@mishig25
Copy link
Collaborator

mishig25 commented Jan 29, 2024

Should I leave the .ipynb or remove it? For .mdx files we don't specify it.

remove it. Handled in 6997623

I want to add an index page. Is it ok to have it as a .mdx file?

Yes, you can actually have it just in .md rather than .mdx. It doesnt make difference

notebooks/en/_toctree.yml Outdated Show resolved Hide resolved
@MKhalusova
Copy link
Contributor Author

@mishig25 I've updated the titles in the TOC to make them shorter, and added an index page.

I can add the content for the index page in the separate PR so that we could merge this one sooner and work on things in parallel.

@mishig25
Copy link
Collaborator

Great! I can continue on this PR bit

@MKhalusova
Copy link
Contributor Author

Updated this PR with main (notebook outputs)

@mishig25 mishig25 merged commit e4df795 into huggingface:main Feb 1, 2024
@mishig25
Copy link
Collaborator

mishig25 commented Feb 1, 2024

using huggingface/doc-builder#469

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.

2 participants