Skip to content

Docs: Rule page links previews show the 🛑 warning #5425

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Here is @JamesHenry posting https://typescript-eslint.io/rules/explicit-member-accessibility in Slack:

@JamesHenry on Slack posting a link preview of https://typescript-eslint.io/rules/explicit-member-accessibility/, showing that it still shows the _This file is source code, not the primary documentation location!_ warning

The notice was added to all rule docs file in #5249:

> 🛑 This file is source code, not the primary documentation location! 🛑

remarkPlugins: [...remarkPlugins, [generatedRuleDocs, {}]],

// 1. Remove the " 🛑 This file is source code, not the primary documentation location! 🛑"

Will moving this to beforeDefaultRemarkPlugins fix the preview? If not, is there anything we can do?

Affected URL(s)

https://typescript-eslint.io/rules/*

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuebugSomething isn't workingpackage: websiteIssues related to the @typescript-eslint website

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions