PowerShell / PowerShell/PowerShellEditorServices

No user documentation?

Ouverte
#968 6 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Area-Documentation Issue-Enhancement
Langage dominant
C#
Étoiles
767
Forks
266
Merge moyen
3 j 16 h
PR mergées (30 j)
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:

  1. README (that has been saying "detailed usage documentation...coming soon!" since 2017)
  2. Docs (that haven't changed since 2016)
  3. 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!

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par comparer le README et Docs, que l’issue identifie comme obsolètes, avec le code COC PowerShell référencé. Établissez la configuration actuelle de STDIO et documentez les AdditionalModules et FeatureFlags disponibles. Le travail est considéré comme terminé lorsque les utilisateurs peuvent configurer PSES et exécuter le mode STDIO à partir de la documentation à jour du projet.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
powershell
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.