boostorg / boostorg/iostreams

Documentation format

Open
#167 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
48
Forks
124
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 reviewing how the iostreams documentation is displayed on the boost.org website and where the HTML frames are produced. Determine whether the documentation can be converted to AsciiDoc or whether the frames can otherwise be removed; done means the documentation displays correctly without the breaking frame layout.

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.