internetarchive / internetarchive/fatcat

Consider switching guide.fatcat.wiki from mdbook (rust) to mkdocs (python)

Open
#52 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
121
Forks
18
PR merge metrics
No merged PRs in 30d

Description

The main motivation would be an easier to read and navigate theme. We could write or port a theme to mdbook, but the docs are "just markdown" so it would also be easy to switch to mkdocs, which has a larger community and optional features/plugins.

Here's an example theme that is particularly readable; we'd want to host fonts ourselves on (eg) archive.org:

https://squidfunk.github.io/mkdocs-material/getting-started/

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing how guide.fatcat.wiki currently builds and publishes its Markdown through mdBook, then compare the proposed MkDocs Material theme and its font-hosting requirements. Done means agreeing on the migration approach and scope, with the guide rendered through the chosen system and its navigation and readability improved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
build-system, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.