space-wizards / space-wizards/docs

Replace mdbook with something else

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

Nobody has claimed this yet.

Dominant language
CSS
Stars
42
Forks
304
PR merge metrics
No merged PRs in 30d

Description

  • This entire tool is an architectural mess that constantly breaks on version changes.
  • It's not even that flexible since we can only have one ToC
  • It's not even fast

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

The issue names mdBook as the current documentation tool but does not identify files, tests, or a replacement. Start by locating the mdBook configuration and build entry points, then compare replacement options against version stability, multiple ToCs, and build speed. Done requires an agreed replacement and a working documentation build.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.