source-cooperative / source-cooperative/docs.source.coop
Add instructions for MacOS/Linux vs. Windows with toggle between them
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 2
- Avg merge
- 25m
- Merged PRs (30d)
- 2
Description
Some of the current terminal/shell instructions are specific to linux-based terminals, and do not work for Windows users using Powershell.
Example: https://docs.source.coop/data-upload#for-terminal--shell-usage
In the case where the shell instructions are different, we could display them on separate tabs of the code block.
- Easy to implement in Docusaurus. See https://docusaurus.io/docs/markdown-features/tabs
- Easy to implement with MystMD. See https://mystmd.org/guide/dropdowns-cards-and-tabs#tabs
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.
Research direction
Start with the linked data-upload page and review the terminal/shell instructions that currently assume Linux. Check the Docusaurus tabs and MystMD tabs references, then separate differing MacOS/Linux and Windows PowerShell commands into toggleable sections; done means Windows users can follow the page successfully without losing the existing instructions.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100