This week, I embarked on creating a translation for the audio course project into Brazilian Portuguese. Following the instructions outlined in the project's README, I installed the latest version of doc-builder. However, during my initial usage of the doc-builder preview command, I encountered a couple of significant issues.
Firstly, only the Table of Contents (TOC) was rendered correctly, and any attempt to click on the links within the TOC resulted in a 404 error. This was quite puzzling and hindered the progress of my work. Additionally, I noticed that the preview was running on port 5173, which deviated from the port 3000 specified in the README documentation.
To troubleshoot this issue, I took the step of cloning the doc-builder project and switching to version 0.4.0 before installing it. Remarkably, after this adjustment, the doc-builder preview functioned as expected. The links in the TOC now correctly loaded the corresponding chapters.
This experience led me to surmise that the audio course project might not yet be fully compatible with the recently released version 0.5 of doc-builder. I am curious if others have encountered similar issues and can confirm my observations. If this incompatibility is indeed the case, it might be prudent to update the README.md of the audio course project to reflect the current situation until there is support for doc-builder version 0.5.
It's important to note that merely installing doc-builder version 0.4.0 via pip (using pip install doc-builder==0.4.0) did not resolve the issue due to an additional problem with doc-builder itself. I have already submitted a pull request to address this specific problem, which can be reviewed here: https://github.com/huggingface/doc-builder/pull/489. This PR aims to rectify the underlying issue and ensure smoother operation for those using version 0.4.0 of doc-builder in their projects.
This week, I embarked on creating a translation for the audio course project into Brazilian Portuguese. Following the instructions outlined in the project's README, I installed the latest version of doc-builder. However, during my initial usage of the
doc-builder previewcommand, I encountered a couple of significant issues.Firstly, only the Table of Contents (TOC) was rendered correctly, and any attempt to click on the links within the TOC resulted in a 404 error. This was quite puzzling and hindered the progress of my work. Additionally, I noticed that the preview was running on port 5173, which deviated from the port 3000 specified in the README documentation.
To troubleshoot this issue, I took the step of cloning the doc-builder project and switching to version 0.4.0 before installing it. Remarkably, after this adjustment, the
doc-builder previewfunctioned as expected. The links in the TOC now correctly loaded the corresponding chapters.This experience led me to surmise that the audio course project might not yet be fully compatible with the recently released version 0.5 of doc-builder. I am curious if others have encountered similar issues and can confirm my observations. If this incompatibility is indeed the case, it might be prudent to update the README.md of the audio course project to reflect the current situation until there is support for doc-builder version 0.5.
It's important to note that merely installing doc-builder version 0.4.0 via pip (using
pip install doc-builder==0.4.0) did not resolve the issue due to an additional problem with doc-builder itself. I have already submitted a pull request to address this specific problem, which can be reviewed here: https://github.com/huggingface/doc-builder/pull/489. This PR aims to rectify the underlying issue and ensure smoother operation for those using version 0.4.0 of doc-builder in their projects.