`mdbook serve` clobbers old versions of docs

Open Beginner friendly
#1,367 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
build-system, documentation

Research direction

Start by inspecting docs/release and the build_docs::all_with_old recipe in just, then reproduce the conflict with mdbook serve -o. Identify references that depend on the docs/release path and choose a non-conflicting name. Done means building old documentation and running mdbook serve no longer removes book/release or its contents.

Written by the indexing model from the issue text.

Description

bug documentation

Not an especially important bug.

I often run mdbook serve -o to view the documentation once I've built it, but if you build the old docs (just build_docs::all_with_old) then run mdbook, the old docs are deleted again. The problem is that we have a folder at docs/release which just contains some Python code, but release is also the name of the folder where we put old versions of docs when we generate them. When you run mdbook serve it clobbers the contents of book/release with docs/release.

You can just open book/index.html directly instead. We could fix this by renaming docs/release to something else.

Dominant language
Rust
Stars
8
Forks
5
Avg merge
11h 31m
Merged PRs (30d)
33

Contributor guide

Open the contributing guide

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.

More from EnergySystemsModellingLab/MUSE2

All issues in EnergySystemsModellingLab/MUSE2

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.