Missing description of what QuickBook is
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by locating the documentation's introduction and the current explanation of QuickBook. Clarify what QuickBook converts, whether it can be used without BoostBook, and make the introductory documentation answer those questions directly; the documentation should let a new reader understand the tool and its standalone use.
Written by the indexing model from the issue text.
Description
From the docs I cannot figure out what QuickBook is. The introduction tells me about the history but not what it is. It is a tool that converts qbk files to something else, right? But what?
Can I use QuickBook without a BoostBook? The docs do not tell me this in a straight way.
- Dominant language
- C++
- Stars
- 15
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from boostorg/quickbook
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Spurious warning Open
Difficulty 2/5 1-3 hours Newbie friendliness 58/100
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
All issues in boostorg/quickbook
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
games-on-whales/wolf#509 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
bug-unconfirmed
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
NVIDIA/cuda-samples#453 ·