Skip to content

docs/ no tiene documentacion: son 6 MB de un sitio compilado #3

Description

@leocagli

La carpeta docs/ no contiene documentacion. Contiene el resultado de compilar un
sitio web, commiteado.

La evidencia

$ ls -la docs/
   1103  404.html
    894  index.html
  81860  index-8PaU6JJo.css
2033305  index-D3-mAlci.js
   9856  logo-OZlxya_r.svg
1987920  typezero-hero-Cz7_U_3z.png
2093342  xray-hero-DoQlJw3x.png

Casi 6 MB. Ni un archivo de texto que explique nada.

Dos detalles que valen la pena:

  1. Los nombres estan hasheados (index-D3-mAlci.js). Cada vez que alguien
    reconstruya el sitio, los archivos nuevos entran con otro hash y los viejos se
    quedan. El repositorio engorda para siempre.

  2. typezero-hero y xray-hero son de otros proyectos. No pertenecen a este
    repositorio. Son de la pagina personal del autor original.

Por que importa

Quien entra a docs/ buscando como usar esto, no encuentra nada. Y quien clona el
repositorio se lleva 6 MB de imagenes de otros proyectos.

Direccion del arreglo

  • Sacar el sitio compilado de docs/ y agregar el directorio de salida al
    .gitignore
  • Si el sitio tiene que seguir publicandose, que lo construya el CI y lo empuje a
    una rama gh-pages, en vez de vivir en main
  • Poner en docs/ documentacion de verdad: que hace cada contrato, cual es el
    flujo de una partida, y como se despliega
  • Considerar git gc despues, aunque el peso historico solo se saca reescribiendo
    la historia, cosa que probablemente no valga la pena

Como se toma este trabajo: comentá la issue con un plan concreto (que archivo, que
funcion, y como lo vas a verificar). Se asigna por la calidad de ese plan, no por
orden de llegada. La PR va despues de la asignacion, con el cambio real adentro.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardThird CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions