← Back to issue list

docs: recommend nano instead of vi in tutorial setup

View original Github issue

Metadata

Project
rockcraft
Number
#1331
Type
pull request
State
merged
Author
aahil-khan
Labels
—
Created
Updated
Closed

Current evaluation

Merged docs PR (commit 62412612) replaced `vi` with `nano` in the shared setup_stable.rst/setup_edge.rst tutorial includes, affecting all six 12-factor tutorials and closing canonical/open-documentation-academy#373.

Resolution: closed resolved

Reason: The PR itself was merged into the main branch as commit 62412612 ("docs: recommend nano instead of vi in tutorial setup (#1331)"), with all CI checks passing and 3 approving reviews. The two-line diff updates the shared stable/Edge setup includes so all six tutorials (Django, Express, FastAPI, Flask, Go, Spring Boot) now recommend nano.

Evaluated by: mr-cal-bot

No scores available.

Issue body

## Summary - Replaces `vi` with `nano` as the suggested pre-installed text editor at the end of the Setup section, per user research showing `nano` is preferred. - Both `docs/reuse/tutorial/setup_stable.rst` and `docs/reuse/tutorial/setup_edge.rst` are updated. These are shared includes, so the change applies to all six web app framework tutorials: Django, Express, FastAPI, Flask, Go, and Spring Boot. Closes canonical/open-documentation-academy#373 ## Test plan - [x] `grep` confirms no remaining `vi` references in the tutorial docs - [x] Confirmed all six tutorials include `setup_stable.rst` or `setup_edge.rst` within their Setup section

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged docs PR (commit 62412612) replaced `vi` with `nano` in the shared setup_stable.rst/setup_edge.rst tutorial includes, affecting all six 12-factor tutorials and closing canonical/open-documentation-academy#373.
stealth/space-bunny-alpha — closed resolved Merged docs PR replaced vi with nano in shared stable and Edge tutorial setup docs, resolving canonical/open-documentation-academy#373; all CI checks passed.
qwen/qwen3.6-35b-a3b — — Merged documentation update replacing vi with nano as the recommended setup editor. Changes to shared includes apply to six framework tutorials, closes issue #373, and passed three reviews and all CI checks.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 95
needs review Replaces vi with nano in shared tutorial setup documentation across six web frameworks. Approved by three reviewers with zero unresolved comments and passing checks. Ready to merge.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 95
needs review Replaces vi with nano in shared tutorial setup documentation across six web frameworks. Approved by two reviewers with zero unresolved comments and no CI checks required.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Updates tutorial setup documentation to recommend nano over vi. Changes apply to shared includes for six web framework tutorials. Approved by one reviewer, awaiting merge.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Updates shared tutorial documentation to recommend nano over vi for text editing. Applies to six web framework tutorials. Currently pending maintainer review with no CI checks configured.

Update history

Date Change
updated
updated
updated
updated
updated
created

Related work

  • Likely Fixed By: open-documentation-academy#373 (confidence 90%)

    Tracked upstream docs/UX issue requesting nano instead of vi in the tutorial setup; explicitly cited as closed by this PR.

  • Related To: canonical/rockcraft#827 (confidence 55%)

    Earlier 'docs: tutorial setup maintenance' commit on the same shared setup_stable.rst/setup_edge.rst files.

  • Related To: canonical/rockcraft#1006 (confidence 50%)

    Prior UX-feedback pass over the 12-factor tutorial setup docs, same files, same rationale of user research.

Related issues

No related issues found above the similarity threshold.