Rust-GPU / Rust-GPU/rust-gpu.github.io

Consider moving the website into main rust-gpu repo

Ouverte
#14 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
MDX
Étoiles
16
Forks
8
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

I just threw it in here as that was the quickest way to get the webpage up with github pages.

Docs/website in the main repo:

Pros:

  • Docs stay close to the code, so it’s easier to keep them updated alongside changes.
  • Contributors only need to work in one place, so adding or updating docs is straightforward.
  • No need to manage multiple repos—everything lives together.
    Cons:
  • The repo gets bigger, which can slow down cloning and pull requests for everyone.
  • Mixing code and doc issues in one place can get messy, making it harder to focus on core development.

Using a separate repo for docs/website:

Pros:

  • Keeps the main repo cleaner and code-focused, so it’s easier to navigate.
  • Doc updates are simpler to track and review on their own, without touching the code.
  • Main repo stays leaner and faster to work with.
    Cons:
  • It’s tougher to keep docs in sync with code changes, as they’re in different places.
  • Managing a separate repo adds overhead, like additional issue tracking and reviews.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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

Cette issue est une proposition d’organisation du dépôt plutôt qu’une tâche d’implémentation définie. Examinez le dépôt actuel du site web et le dépôt principal rust-gpu, puis décidez où le site web et la documentation doivent être hébergés. La tâche est considérée comme terminée lorsqu’une décision claire a été prise et consignée, y compris la portée de toute migration.

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

Évaluation

Domaine
documentation
Type d'issue
Refactorisation
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.