Skip to content

Recommended way to file docs issue forms a circularity #2866

Closed
@DerekNonGeneric

Description

@DerekNonGeneric

This issue is related to user journey.

  • The currently recommended way of filing a documentation-related issue is confusing.
  • There is no documentation-related issue template.

Circularity confusion

The core repo suggests filing an issue in the Node.js website repo (this one).

🌐 Found a problem with nodejs.org?
Please file an issue in the Node.js website repo.

This repo suggests filing an issue in the main Node.js repo (core).

📗 Node.js API Docs
Please open an issue in the main Node.js repo, prefixed with "doc".

These instructions seem wrong and this is probably unintended.

Missing issue template

If the intended way of filing documentation-related issues is in the core repo with the issue title prefixed with "doc", there should probably be an issue template for this. There's a frontmatter field named title that can pre-fill the issue's title field with doc: for people.


I'm not sure if issues are being triaged during the holidays, but this could be medium to high priority item from a documentation perspective.

/cc @nodejs/documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions