PowerShell / PowerShell/PowerShellEditorServices
No user documentation?
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 767
- Forks
- 266
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 1
Description
The Short
Could not figure out how to run in STDIO mode. Could find no up-to-date documentation.
The Long
After discovering that this project has a general STDIO LSP mode, I wasted time between the:
- README (that has been saying "detailed usage documentation...coming soon!" since 2017)
- Docs (that haven't changed since 2016)
- Issue comments
before eventually figuring it out by referring to COC's code.
I still have no idea what possible -AdditionalModules or -FeatureFlags exist, or whether I've even configured PSES correctly.
I would really appreciate some up-to-date documentation!
Contributor guide
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 by comparing the README and Docs, which the issue identifies as outdated, with the referenced COC PowerShell code. Establish the current STDIO setup and document the available AdditionalModules and FeatureFlags. Done means users can configure PSES and run STDIO mode from up-to-date project documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100