microsoft / microsoft/docusaurus-plugins

Documentation point to wrong `npm` package

Open
#46 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
17
Forks
6
Avg merge
1d 12h
Merged PRs (30d)
1

Description

Hello, I wanted to try the plugin remark-plugin-import-file if it fit my use case. However, there seems to have a lot of discrepancies in this repository regarding this package. Probably due to the recent changes in namespace?

What is working

What is not aligned what is working

  1. README.md

  2. Documentation

  3. Documentation

Regards!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare README.md and website/docs/plugins/docusaurus-remark-plugin-import-file.mdx with packages/docusaurus-remark-plugin-import-file/package.json. Update the documented package title and install command to match the package name shown in package.json and the npm page. Done means the README and plugin documentation consistently identify the same package.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.