PowerShell / PowerShell/PowerShellEditorServices

No user documentation?

Abierto
#968 6 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Area-Documentation Issue-Enhancement
Lenguaje dominante
C#
Estrellas
767
Forks
266
Merge medio
3 d 16 h
PR fusionados (30 d)
1

Descripción

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!

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza comparando el README y Docs, que el issue identifica como obsoletos, con el código COC PowerShell referenciado. Establece la configuración actual de STDIO y documenta los AdditionalModules y FeatureFlags disponibles. Se considera terminado cuando los usuarios pueden configurar PSES y ejecutar el modo STDIO a partir de la documentación actualizada del proyecto.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
powershell
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.