Skip to content

Conversation

@enjeck
Copy link
Contributor

@enjeck enjeck commented Jan 24, 2026

The current theme doesn't provide a table of contents, search or versioning for the docs. Mkdocs provides this for us. This PR migrates to Mkdocs, and hopefuly, the set up is correct for deploying to GitHub pages. In a follow up PR, I'll add support for versioned docs

This is what it looks like:
Screenshot 2026-01-24 at 17 26 36

@dromer
Copy link
Collaborator

dromer commented Jan 24, 2026

Hey thanks a lot! I've been thinking about how we could add better docs hosting.
Mkdocs also came on my radar recently, but I had not played with it yet.

Adding ToC, dark/light and versioned docs are all super nice and exactly what we need! :)

I'll need to try these builds locally (also something I was never able to reproduce with jekyll) first to be able to get into review.

@dromer
Copy link
Collaborator

dromer commented Jan 24, 2026

First off: do you mind changing the deleted files into renames in the history? :)

@enjeck
Copy link
Contributor Author

enjeck commented Jan 24, 2026

I'll need to try these builds locally (also something I was never able to reproduce with jekyll) first to be able to get into review.

After installing dependencies, mkdocs serve should do it

@enjeck
Copy link
Contributor Author

enjeck commented Jan 24, 2026

First off: do you mind changing the deleted files into renames in the history? :)

Uh, how do you mean? It there a git command?

@dromer
Copy link
Collaborator

dromer commented Jan 24, 2026

git mv <old_path> <new_path>

This way file history stays intact instead of recreating the files. Somehow it happened only on these two files as far as I can see.

@dromer
Copy link
Collaborator

dromer commented Jan 24, 2026

We should cleanup _config.yml as that was for the jekyll setup.

Also we can add the CONTRIBUTING.md and CODE_OF_CONDUCT.md as well.

@enjeck
Copy link
Contributor Author

enjeck commented Feb 8, 2026

git mv <old_path> <new_path>

This way file history stays intact instead of recreating the files. Somehow it happened only on these two files as far as I can see.

Sorry, I can't figure out how to cleanly do this without messing up the commits 😭

@dromer
Copy link
Collaborator

dromer commented Feb 8, 2026

It's ok, there were not that many changes on these files anyway :)

@dromer dromer merged commit 06a8a4b into Wasted-Audio:develop Feb 9, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants