RunestoneInteractive / RunestoneInteractive/rs

Documentation could be improved to describe how to set-up dev environment to locally build books that include languages like C++

Open
#542 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
69
Forks
117
Avg merge
6d 4h
Merged PRs (30d)
24

Description

Please check the current issues
Did not see this issue.

What Page were you on
https://runestone-monorepo.readthedocs.io/en/latest/addbook.html

Describe the bug
The documentation describes how to build the Overview and Active Calculus books but not thinkcpp, cpp4python, etc.

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.

Research direction

Start with the addbook documentation page linked in the issue and review how it currently explains local builds for the Overview and Active Calculus books. Document the development setup and build steps for books such as thinkcpp and cpp4python, then verify that the instructions cover those C++ book builds.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.