Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Improve default styling and top-level content layout

Aberta
  • Algo errado?
#34 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
20/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
css, fsharp, html
Domínio
design, documentation, web-dev

Direção de pesquisa

Comece revisando o _template.html padrão atual e os estilos usados pelo FSharp.Formatting; em seguida, compare as questões listadas sobre layout, overflow, espaçamento, nomes de funções e links do logotipo. Use a discussão e os exemplos visuais solicitados na issue para definir critérios de aceitação concretos. O trabalho estará concluído quando as alterações de design e conteúdo acordadas forem implementadas e o layout da documentação gerada for verificado nas visualizações para desktop e mobile.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
Sem dados de linguagem
Estrelas
37
Forks
20
Merge médio
3min
PRs com merge (30d)
1

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de fsharp/fsharp-core-docs

Todas as issues de fsharp/fsharp-core-docs

Issues semelhantes

Mais issues de Design

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.