boostorg / boostorg/url

Explore including changelog in docs

Open
#782 0 comments 0 reactions 0 assignees View on GitHub
Doc Unactionable
Dominant language
C++
Stars
205
Forks
60
PR merge metrics
No merged PRs in 30d

Description

We don't have a revision history section (changelog) in the documentation. We have been counting on boost release notes only. When looking at a specific lib it's not particularly convenient to have to look in the boost release notes for its changes.

We can move that content to the docs and start from there. Then we can maintain it in my docs and copy it to the boost release notes.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the current Boost.URL documentation and the Boost release notes to identify how library-specific changes are recorded. Define a documentation revision-history section that can be maintained with the library docs and copied to the release notes; the issue does not name specific files or tests.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.