fix(readme): preview setup changes into a directory the clone command does not create

Abierto Apto para principiantes
#649 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
git

Línea de trabajo

La discrepancia está en README.md, en la secuencia de vista previa local alrededor de las líneas 9-24: el comando de clonación git clone --recursive https://github.com/rustdesk/doc.rustdesk.com.git crea doc.rustdesk.com, pero el siguiente paso ejecuta cd docs.rustdesk.com. Decide si debe cambiar el comando de clonación o el destino de cd para que coincidan, y revisa el resto de la secuencia por si aparece el mismo nombre. Está terminado cuando un clon nuevo en un directorio vacío seguido del cd documentado tiene éxito y termina dentro del repositorio.

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

Descripción

Summary

The README's local preview instructions clone this repository without specifying a destination directory, then run cd docs.rustdesk.com. Git creates doc.rustdesk.com, so the documented directory-change step fails in a fresh parent directory before the reader can start Hugo.

Steps to reproduce

  1. In a new empty parent directory, clone the repository without specifying a destination directory. The README uses git clone --recursive https://github.com/rustdesk/doc.rustdesk.com.git.
  2. Run the README's next command: cd docs.rustdesk.com.

The local reproduction used git clone --depth 1 --no-checkout https://github.com/rustdesk/doc.rustdesk.com.git to observe Git's default destination without setting up submodules or the site. It then executed the documented directory-change command. The recursive clone and Hugo startup were not run.

Expected behavior

The README's “Change to the folder” step should enter the repository directory created by its immediately preceding clone command, allowing the following local-preview step to run from that checkout.

Actual behavior

The clone reported Cloning into 'doc.rustdesk.com'.... The documented directory-change command then failed:

zsh:cd:1: no such file or directory: docs.rustdesk.com

Its exit status was 1. As a control, cd doc.rustdesk.com && test -d .git succeeded with exit status 0 in the same parent directory. No Hugo build or server was started.

Runtime or environment

  • Documentation: master at 56f9310ca2c91f8e94b6a460290d1e94f62e0482 in a fresh clone.
  • Reproduction: Git HTTPS clone and a zsh -f directory-change command in an empty disposable parent directory.

Evidence

  • Expected source: The README local-preview sequence explicitly follows cloning with changing into the folder and starting Hugo.
  • Failure source: The documented clone URL has basename doc.rustdesk.com.git, while the next command uses docs.rustdesk.com; the local clone and shell output above reproduce the mismatch.
  • Evidence provenance: observed
  • Local verification: reproduced
  • Reproduction completeness: complete

Clone destination, failing directory-change command, and successful control were directly observed.

The directory-selection failure was reproduced using a shallow clone without checkout. The full recursive clone and Hugo preview were not tested.

Restoration check

In a new empty parent directory, use the documented clone and directory-change steps. Pass when the directory-change command succeeds and the working directory is the newly cloned repository. This check concerns the directory-selection step; starting Hugo is a separate step and was not verified here.

References

PR #540 revised the README's preview instructions and was merged, but preserved the directory-name mismatch. The current report concerns that remaining failing step; it does not request a comment on the closed PR.

Triage assessment

  • Impact level: P2
  • Assessment status: supported
  • Impact basis: The documented fresh-clone preview sequence stops at the directory-change command. The failure is bounded to readers following that setup sequence and has a directly verified workaround.
  • Workaround status: available
  • Workaround basis: Changing into doc.rustdesk.com succeeded and verified the cloned Git directory in the same reproduction. This restores the directory-selection step without requiring a documentation change or extra permissions.
Lenguaje dominante
HTML
Estrellas
822
Forks
720
Merge medio
2 h 8 min
PR fusionados (30 d)
2

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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.

Más de rustdesk/doc.rustdesk.com

Todos los issues de rustdesk/doc.rustdesk.com

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.