Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Documentation format

Open
#52 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
html
Domain
documentation

Research direction

Start by inspecting the current documentation HTML as displayed on boost.org and identify where elements are used. Compare the proposed AsciiDoc modernization with removing frames or opening the documentation in a new tab; done requires an agreed approach and a verified display without the reported breakage.

Written by the indexing model from the issue text.

Description

We are working on updating the boost.org website, and when displaying the documentation of this boost library in that environment the display breaks due to the fact that <frame>s are used in the html. There will probably be a work-around, such as opening the docs in a new browser tab, but it would be preferable to either convert these docs to AsciiDoc as a modernization, or otherwise remove <frame>.

Dominant language
C++
Stars
118
Forks
76
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from boostorg/preprocessor

All issues in boostorg/preprocessor

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.