-
Notifications
You must be signed in to change notification settings - Fork 74
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
chore: bump Docusaurus to v3 #1176
Conversation
- <https://python.langchain.com/docs/integrations/providers/apify> | ||
- <https://python.langchain.com/docs/integrations/tools/apify> | ||
- <https://python.langchain.com/docs/modules/model_io/llms/> | ||
- [https://python.langchain.com/docs/get_started/introduction](https://python.langchain.com/docs/get_started/introduction) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we really need to do this? i thought this is enough
- [https://python.langchain.com/docs/get_started/introduction](https://python.langchain.com/docs/get_started/introduction) | |
- https://python.langchain.com/docs/get_started/introduction |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Uh oh, apparently the markdown linter in the CI checks doesn't like bare URLs.
And the apparent fix is to enclose it in angle brackets, isn't that convenient 🙃
I'm all for bare URLs; you're right that writing the same URL twice makes it less readable (i.e., not really what using linter should do). I'll check what we can do to disable this rule in markdownlint - is that okay with you @TC-MO ?
sources/academy/platform/get_most_of_actors/naming_your_actor.md
Outdated
Show resolved
Hide resolved
we will also need to wait for milesj/docusaurus-plugin-typedoc-api#156 to be merged/released, or alter those imports via patch package, some projects like the js SDK use versioning and this will pop up in those |
Right, I already fixed this (for Python Crawlee) in our fork of that package, but you're right that we're using the original package in the JS projects. Maybe it's time to switch the JS projects to our fork too? Once we want to make some changes to how the rendered docs look like (you know, the ones that I was promising since 6 months ago), we can deploy it over all our projects at once (Python and JS alike). |
yeah, if its still compatible with js projects, lets do that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
} from '@docusaurus/theme-common/internal'; | ||
} from '@docusaurus/plugin-content-docs/client'; | ||
import { ThemeClassNames } from '@docusaurus/theme-common'; | ||
import { useHomePageRoute } from '@docusaurus/theme-common/internal'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i thought the /internal
imports are no longer allowed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From what I understood, the Docusaurus team removed some theme-common
package dependencies, as they didn't make sense from the "big-picture" POV. The theme-common/internal
module was reexporting some of the symbols from those dependencies, which then indeed stopped working.
The useHomePageRoute
hook is defined inside of theme-common
, though, so it still works. Honestly, I don't really like importing something called internal
either, but... as long as it works, I guess I'm fine?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah sure, that's why I gave you the checkmark right ahead, build is passing, so it's fine.
Following the bump of
@apify/docs-search-modal
to Docusaurus v3, this PR bumps the Docusaurus dependency version in@apify/docs-theme
and the Apify Docs themselves.This is required for Docusaurus version bump in all the subprojects (SDK docs, Client docs etc.)
The changes follow the official v3 migration guide.