Documentation point to wrong `npm` package
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- documentation
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.
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
- NPM package page: https://www.npmjs.com/package/@rise4fun/docusaurus-remark-plugin-import-file
pnpmadd command:pnpm add @rise4fun/docusaurus-remark-plugin-import-file- I would assume it's the same for
npm installandyarn add.
- I would assume it's the same for
What is not aligned what is working
-
README.md
- Source
https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/packages/docusaurus-remark-plugin-import-file/README.md?plain=1#L3 - Issue
Looks like a typo in the package name? Wordfileis ending with as, but the package isn't.
https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/packages/docusaurus-remark-plugin-import-file/package.json#L2
- Source
-
Documentation
- Source
https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/website/docs/plugins/docusaurus-remark-plugin-import-file.mdx?plain=1#L5 - Issue
The title of the package in the docs (including elsewhere this title is reused by Docusaurus) does not match the package name. Looking at Docusaurus itself for their plugins, they just leave the scope (plugin-content-docs=@docusaurus/plugin-content-docs). Meaning, when reading the docs I assumed the package name wasremark-plugin-import-file, plus whatever scope. But it is not!
- Source
-
Documentation
- Source
https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/website/docs/plugins/docusaurus-remark-plugin-import-file.mdx?plain=1#L18 - Issue
Thenpmpackage name shown in the command does not match either doc title or package itself.
- Source
Regards!
- Dominant language
- TypeScript
- Stars
- 17
- Forks
- 6
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 1
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/docusaurus-plugins
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
microsoft/docusaurus-plugins#51 · 1 comment · 2 reactions ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
[feat][@rise4fun/docusaurus-remark-plugin-import-file]: Add an option to always import a given file Open
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 3/5 1-2 days Newbie friendliness 30/100
All issues in microsoft/docusaurus-plugins
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
ontola/atomic-server#1625 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
melgarafael/DeskcommCRM#1451 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
bug via-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bot:ai-assisted component:compact-js status:untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
midnightntwrk/midnight-sdk#403 ·