Discoverability: social preview, landing page, comparison section and a launch post

Abierto
#77 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
18/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
python

Línea de trabajo

Start with the README and the repository’s GitHub Pages settings; the issue proposes a static page in docs/ or a gh-pages branch, plus README edits and repository settings changes. Create the landing page with a download link and FAQ, add the factual comparison section, and prepare the social preview and launch announcement. Done means the homepage, social preview, landing page, README comparison, and announcements in at least two places are in place.

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

Descripción

documentation marketing priority: medium

Why it matters

The README is now genuinely good, but almost nobody reaches it: the repo has 0 stars, no homepage URL, and no custom social preview, so links shared on Reddit, Discord or X render as a generic GitHub card. "Autoclicker" is a crowded search space dominated by long-standing closed-source tools, so this project needs a clear "why this one" message and a place search engines can index.

Evidence

  • gh repo view: homepageUrl empty; Discussions disabled.
  • No social preview image set (repository Settings, Social preview).
  • README has no comparison to the tools people already know, even though this project has real differentiators: open source and auditable, built in CI with checksums and provenance, safety stops on by default, no system-wide keyboard hook (RegisterHotKey), no ads or bundled installers.

Suggested approach

  1. Social preview: a 1280x640 image (logo, tagline, screenshot) uploaded in repo settings.
  2. Landing page on GitHub Pages (single static page in docs/ or a gh-pages branch): hero with download button, the safety story, timing diagram, FAQ ("Is it safe?", "Why does SmartScreen warn?", "Does it work in games?"). Set it as the repo homepage.
  3. "Why this one" section in README and page: a short, factual comparison table against typical freeware autoclickers (open source, verifiable builds, no installer, safety defaults, multi-monitor). Keep wording neutral and avoid "anti-detection" phrasing per project conventions.
  4. Launch: post a 1.5.0 announcement in relevant communities (r/software, r/windows, r/opensource), add to curated lists (e.g. awesome-windows), and enable Discussions for Q&A.

Done when

  • The repo has a homepage URL, a custom social preview, a landing page with download and FAQ, and a README comparison section; the 1.5.0 release has been announced in at least two places.
Lenguaje dominante
Python
Estrellas
0
Forks
2
Merge medio
2 d 13 h
PR fusionados (30 d)
2

Preparar el entorno

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 TMHSDigital/autoclicker

Todos los issues de TMHSDigital/autoclicker

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.