Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Improve default styling and top-level content layout

Offen
#34 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
20/100
Issue-Typ
Feature
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
css, fsharp, html
Bereich
design, documentation, web-dev

Rechercherichtung

Beginnen Sie mit der Überprüfung des aktuellen standardmäßigen _template.html und der von FSharp.Formatting verwendeten Formatierung. Vergleichen Sie anschließend die aufgeführten Aspekte zu Layout, Überlauf, Abständen, Funktionsnamen und Logo-Links. Verwenden Sie die in diesem Issue angeforderte Diskussion und die visuellen Beispiele, um konkrete Abnahmekriterien festzulegen. Als erledigt gilt die Aufgabe, wenn die vereinbarten Design- und Inhaltsänderungen implementiert sind und das Layout der generierten Dokumentation in Desktop- und mobilen Ansichten überprüft wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
Keine Sprachdaten
Sterne
37
Forks
20
Ø Merge
5 Min.
Gemergte PRs (30 T.)
2

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus fsharp/fsharp-core-docs

Alle Issues in fsharp/fsharp-core-docs

Ähnliche Issues

Weitere Issues zu Design

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.