Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Documentation omnibus

Abierto
  • ¿Algo no está bien?
#304 0 comentarios 0 reacciones 2 asignados Ver en GitHub

@cmazakas ya está trabajando en esto.

Desde el 27/1/2025.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

The recent move to Antora for Unordered docs has left some minor glitches that we compile in this omnibus issue:

1. Reference sections have "Untitled ..." tab name. See for instance here:

Image

This is due to the fact that reference pages have no main header (note the first subsection begins with ==), which, in the context of Antora, results in the page having no title:

[#unordered_flat_map]
== Class Template unordered_flat_map

:idprefix: unordered_flat_map_

`boost::unordered_flat_map` — An open-addressing unordered associative container[...]

There are two possible approaches to fix this:

  • Somehow assign a title to the page that serves to compose the tab name while still not displaying on the page proper. I've experimented with attributes :notitle:, :showtitle!: etc., to no avail. See this conversation on Antora's support forum.
  • Move all level n sections to level n-1. This looks ugly, as the headers appear too big for my taste.

2. Mobile devices: font size too big in some parts of the reference. See for instance this as it appears on my iPhone 8:

This seems to happen when inserting a block of code inside a "Notes:" construct:
https://github.com/boostorg/unordered/blob/3d2c63f744809cdb4d41047329fc9c4893b6cc8d/doc/modules/ROOT/pages/reference/unordered_flat_map.adoc?plain=1#L913-L940

3. Mobile devices: two clicks needed to go to a TOC section. Tested on my iPhone 8: go to the TOC and click on any entry (in the images below, "Hash Quality") --> the entry becomes underlined and a further click is needed to go through it:

Lenguaje dominante
C++
Estrellas
93
Forks
88
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de boostorg/unordered

Todos los issues de boostorg/unordered

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.