Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Improve default styling and top-level content layout

Ouverte
  • Quelque chose ne va pas ?
#34 2 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
20/100
Type d'issue
Fonctionnalité
Clarté
À clarifier
Activité
À l'abandon
Stack technique
css, fsharp, html
Domaine
design, documentation, web-dev

Piste de recherche

Commencez par examiner le _template.html par défaut actuel ainsi que le style utilisé par FSharp.Formatting, puis comparez les problèmes répertoriés concernant la mise en page, le débordement, l’espacement, les noms de fonctions et les liens du logo. Utilisez la discussion et les exemples visuels demandés dans l’issue pour définir des critères d’acceptation concrets. Le travail devrait être considéré comme terminé lorsque les modifications de conception et de contenu convenues sont implémentées et que la mise en page de la documentation générée a été vérifiée dans les vues bureau et mobile.

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

Description

As noted by @baronfel in #27, the default styling and top-level layout needs improvement.

What is here is the current default styling for FSharp.Formatting using the standard _template.html, which is tight for iteration but we can do better. If necessary we can add a _template.html or fsdocs-styles.css in here though to be honest I'd love it if we could make the default FSharp.Formatting _template.html good enough to be both configurable for the needs of this repo and to satisfy and please.

Please make a note below everything that you do/don't like about the current design, layout and content. If possible give specific (preferably visual) examples of what you want improved, and, if possible, give links to how those improvements might be made in terms of CSS improvements and JS framework changes.

The things I've noticed so far:

  • The scrollbar on the left appears even if its not needed. This is I believe because of horizontal overflow.

  • Agreed with @baronfel the basic look is very sparse (though I quite enjoyed browsing it on my phone earlier). Also this is tricky as the site is not like most other doc sites as it is only doing FSHarp.Core API docs and is not a general tech doc site.

  • The repetition of parameter XML doc with parameter types is a bit painful (this is an F#F issue)

  • There is a glitch iwhere function names and parameters run together for active patterns and some module functions

  • Agreed with @cartermp that the link on the logo should go to https://fsharp.org

Langage dominant
Aucune donnée de langage
Étoiles
37
Forks
20
Merge moyen
3 min
PR mergées (30 j)
1

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

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.

Autres issues de fsharp/fsharp-core-docs

Toutes les issues de fsharp/fsharp-core-docs

Issues similaires

Plus d'issues Design

Recevez les nouvelles issues par e-mail

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