Documentation omnibus

オープン
  • 何か問題がありますか？
#304 コメント 0 件 リアクション 0 件 担当者 2 名 GitHub で見る

@cmazakas がすでに取り組んでいます。

2025年1月27日 から。

評価

この issue はまだ評価されていません。

説明

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:

主要言語
C++
スター
92
フォーク
89
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

boostorg/unordered のほかの issue

boostorg/unordered の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。