Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Improve default styling and top-level content layout

Aperta
#34 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
css, fsharp, html
Ambito
design, documentation, web-dev

Direzione di ricerca

Inizia esaminando l'attuale _template.html predefinito e gli stili utilizzati da FSharp.Formatting, quindi confronta i problemi elencati relativi a layout, overflow, spaziatura, nomi delle funzioni e link del logo. Usa la discussione e gli esempi visivi richiesti nell'issue per definire criteri di accettazione concreti. Il lavoro dovrebbe considerarsi completato quando le modifiche concordate a design e contenuti saranno implementate e il layout della documentazione generata sarà verificato nelle viste desktop e mobile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Nessun dato sulla lingua
Stelle
37
Fork
20
Merge medio
5m
PR unite (30g)
2

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di fsharp/fsharp-core-docs

Tutte le issue di fsharp/fsharp-core-docs

Issue simili

Altre issue su Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.