python / python/python-docs-theme

Implement collapsable navigation menus like Wikipedia on moblie

Aberta
#245 3 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
CSS
Estrelas
90
Forks
78
Merge médio
2d 19h
PRs com merge (30d)
4

Descrição

The Python documentation table of contents is massive. It's unwieldy on a mobile device. A lot of that comes from itemising all the changelogs going back to 3.0 release. In and of itself, that's fine, but it takes a lot of scrolling to find anything. The indentation also isn't terribly clear to identify what is a subheading of what. Highly nested headings exacerbates this.

Collapsable TOC headings, used on sites like Wikipedia, would help tremendously with this. That way, mobile users could see a cleaner layout resembling the desktop TOC display, then be able to drill down into whatever topic they're looking for.

Guia de contribuição

Abrir o guia de contribuição

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.

Direção de pesquisa

Comece inspecionando a marcação do índice do tema e os estilos de navegação móvel; em seguida, compare o layout aninhado atual com a navegação recolhível da Wikipedia. Defina como os títulos devem ser expandidos e recolhidos em dispositivos móveis, incluindo as seções do changelog, e verifique o resultado em um build da documentação com tamanho de dispositivo móvel.

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

Avaliação

Stack de tecnologia
css
Domínio
documentation, frontend
Tipo de issue
Funcionalidade
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

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