django-dbbackup icon indicating copy to clipboard operation
django-dbbackup copied to clipboard

Switch documentation from `ReadTheDocs` to `mkdocs-material`

Open Archmonger opened this issue 10 months ago • 1 comments

Current Situation

I personally dislike rst documentation quite a bit. In my opinion, it's very convoluted and is difficult to read/maintain.

Proposed Actions

We should migrate the docs to use mkdocs-material when we get a chance.

System Information

No response

Archmonger avatar Jun 15 '25 21:06 Archmonger

I support this for all the same reasons.

johnthagen avatar Jun 16 '25 10:06 johnthagen

Since this ticket has very low complexity, going to use this to test whether the new "GitHub AI Agent" feature can automagically complete this.

Archmonger avatar Aug 15 '25 21:08 Archmonger

It overall did pretty well.

The copilot agent only made one significant mistake - it accidentally committed the compiled docs to the PR branch.

All other "manually interventions" on that PR were purely to shoehorn in some grammatical or stylistic changes.

Archmonger avatar Aug 16 '25 07:08 Archmonger