Add an integrated documentation website

Ouverte
#2 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Fonctionnalité
Clarté
À clarifier
Activité
À l'abandon
Stack technique
typescript

Piste de recherche

Commencez par examiner la structure du dépôt et le workflow existant du package TypeScript afin de déterminer où un site de documentation intégré pourrait s'intégrer. Définissez l'approche de déploiement, la prise en charge de Markdown et des extraits de code, le modèle d'extension et la portée de la landing page avant l'implémentation ; le travail sera considéré comme terminé lorsque les forks pourront déployer et personnaliser le site de documentation pour leurs packages.

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

Description

A documentation website baked into the stack so forks can:

  • Deploy it for free
  • Document the open-source package
  • Have a way to support md and code snippets so they can showcase examples
  • Allow easy extension
  • Add cool landing page?
Langage dominant
TypeScript
Étoiles
121
Forks
11
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

  • Aucun Dockerfile ni fichier Docker Compose
  • Propose un modèle de pull request
  • Aucun guide de contribution

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.

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.