← Back to issue list

docs: translate remaining .md files to .rst

View original Github issue

Metadata

Project
charmcraft
Number
#2083
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

Merged in #2083 (8732a51a): converted the 42 remaining Markdown docs to reStructuredText, replacing dropdowns with tabs and 'juju status' bash directives with terminal; completed the docs rework started in #2010.

Resolution: closed resolved

Reason: The PR itself was merged to main as commit 8732a51a ('docs: translate remaining .md files to .rst (#2083)'), following on from the earlier docs restructure merged in #2010 (a1a3d4b1). The docs tree now contains only .rst pages and a repo-wide grep for '.md' returns no matches, so the conversion is complete and durable.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Translated remaining Markdown files from #2010 to reStructuredText. The contents of each page remain largely unchanged, with the main exceptions being: - Dropdowns in [Manage a 12-factor app charm](https://canonical-charmcraft.readthedocs-hosted.com/en/stable/howto/manage-a-12-factor-app-charm/) were replaced with tabs. - Output of `juju status` in [tutorials](https://canonical-charmcraft.readthedocs-hosted.com/en/stable/tutorial/) was changed from a bash code directive to a terminal directive.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged in #2083 (8732a51a): converted the 42 remaining Markdown docs to reStructuredText, replacing dropdowns with tabs and 'juju status' bash directives with terminal; completed the docs rework started in #2010.
stealth/space-bunny-alpha — closed resolved Merged PR #2083 (commit 8732a51a): converted 42 remaining Markdown docs to reStructuredText, finishing #2010; dropdowns became tabs and juju status blocks switched to terminal directives. Follow-up #2085 (79fa5ad9) refined tutorials.
stealth/space-bunny-alpha — closed resolved Merged in #2083 (8732a51a): converted 42 remaining Markdown docs to reStructuredText, replacing dropdowns with tabs and juju status bash directives with terminal.
qwen/qwen3.6-35b-a3b — — Merged documentation update translating 42 Markdown files to reStructuredText. Replaced dropdowns with tabs and updated juju status directives from bash to terminal. Approved by two reviewers.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update translating remaining Markdown files to reStructuredText. Dropdowns were replaced with tabs, and juju status output directives were changed from bash to terminal format.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#2010 (confidence 95%)

    Predecessor docs PR that added/refactored the Discourse docs; #2083 finishes translating its remaining Markdown pages to RST.

  • Related To: canonical/charmcraft#1711 (confidence 55%)

    Introduced the basic Sphinx docs structure that #2083 converted to RST.

Related issues

No related issues found above the similarity threshold.