Skip to content

Runestone Documentation Issue: Adding a part about using git clone instead of the built in help in the bash command #1274

Description

@habibasorour

What Page were you on
https://docs.runestone.academy/en/latest/running.html

Describe the bug
In 6.2, in navigating the command, a recommendation is saying that if you plan on contributing to runestone, using the built-in setup step when asked if you want to add a book, and prompts the user to add a GitHub, won't work even if you forked the book. When you try to work on the book after adding it to the books repo this way, it won't work.

A hint to use `git clone forked_repo_of_book' can be useful here to let people who want to contribute know they should do it inside the books repo instead.

A way it can be mentioned after the last sentence in the screenshot:

Image

"
IMPORTANT: If you plan on contributing to Runestone, type “n” when prompted to add a book and a course in the setup process. To add books, you would need to use git clone forked_repo_of_book the repo so your changes are reflected on the runestone server.
"

What is your username
habibasorour

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions