Skip to content

Find a way to link to category generated-index #6041

@slorber

Description

@slorber

Have you read the Contributing Guidelines on issues?

Motivation

For docs, we recommend using relative file paths:

For our new category index feature, there is no .md file to link to so we must use regular links.

Problem:

  • Using an absolute link would not play well with versioning: [Guides](/docs/next/category/guides).
  • Using a relative link would not play well with changing the trailingSlash setting: [Guides](./category/guides).

This is particularly annoying for our own website, as we use different settings for dogfooding on dev/deployPreview/prod. It is not easy to find a good workaround so that our site could be deployed on every env without reporting broken links 😅 (see workaround ac44531)

It may be annoying for our users too.

We should probably find a way to link more easily to a category, but not sure how this should be done 🤷‍♂️

Self-service

  • I'd be willing to do some initial work on this proposal myself.

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureThis is not a bug or issue with Docusausus, per se. It is a feature request for the future.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions