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

Next version of the docs is not rendered with v3.0.1 #109

Open
B4nan opened this issue Oct 12, 2023 · 3 comments
Open

Next version of the docs is not rendered with v3.0.1 #109

B4nan opened this issue Oct 12, 2023 · 3 comments

Comments

@B4nan
Copy link
Contributor

B4nan commented Oct 12, 2023

Another issue we encountered that holds us from updating, with versioning, the next version (so the snapshot of the current master branch) is not rendered at all and results in 404.

Visible in this renovate PR which updates only the typedoc plugin:

apify/apify-client-js#423

It fails as the /api/client/js/reference/next page is missing, this works fine with the previous version (https://docs.apify.com/api/client/js/reference/next).

@B4nan
Copy link
Contributor Author

B4nan commented Oct 12, 2023

Looking at the docusaurus route debugger, I can see the route is actually registered but has no child routes.

image

Here is our plugin setup:

    plugins: [
        [
            'docusaurus-plugin-typedoc-api',
            {
                projectRoot: `${__dirname}/..`,
                changelogs: false,
                readmes: false,
                packages: [{ path: '.' }],
                typedocOptions: {
                    excludeExternals: false,
                },
                routeBasePath: '/reference',
            },
        ],
        ...config.plugins,
    ],

https://github.com/apify/apify-client-js/tree/master/website

@B4nan
Copy link
Contributor Author

B4nan commented Oct 12, 2023

The generated typedoc JSON for the next version (right) is looking pretty much the same as the versioned ones (left):

image image

the docs are using TS 5.0.4, while the project itself is on TS 5.2.2

@milesj
Copy link
Owner

milesj commented Nov 1, 2023

Pretty sure this is caused by #107 (comment)

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

No branches or pull requests

2 participants