boostorg / boostorg/preprocessor

Documentation format

Open
#52 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
118
Forks
76
PR merge metrics
No merged PRs in 30d

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 ``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 ``.

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.