milesj / docusaurus-plugin-typedoc-api

Docusaurus plugin that provides source code API documentation powered by TypeDoc.
69 stars 25 forks source link

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

Open B4nan opened 11 months ago

B4nan commented 11 months ago

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:

https://github.com/apify/apify-client-js/pull/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 commented 11 months ago

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 commented 11 months ago

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 commented 10 months ago

Pretty sure this is caused by https://github.com/milesj/docusaurus-plugin-typedoc-api/issues/107#issuecomment-1789414073