← Back to issue list

docs: Running Flask, Django and FastAPI should be in a code block

View original Github issue

Metadata

Project
rockcraft
Number
#1145
Type
issue
State
closed
Author
asanvaq
Labels
good first issue Type: Documentation
Created
Updated
Closed

Current evaluation

Fixed and closed after another contributor implemented the requested code block formatting for the Flask, Django, and FastAPI tutorials.

Suggested action:

No scores available.

Issue body

### Check existing issues - [x] I've verified that this request isn't described by any existing issues. ### Request This concerns the Flask, Django and FastAPI tutorials. After the app is created, there are in-line instructions on how to run the app. This does not match the rest of the instructions and can lead to users potenitally missing it. These instructions should have their own code block and the text above it should be updated accordingly. ### Document location https://documentation.ubuntu.com/rockcraft/latest/tutorial/flask/#tutorial-build-a-rock-for-a-flask-app https://documentation.ubuntu.com/rockcraft/latest/tutorial/django/#tutorial-build-a-rock-for-a-django-app https://documentation.ubuntu.com/rockcraft/latest/tutorial/fastapi/#tutorial-build-a-rock-for-a-fastapi-app

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Fixed and closed after another contributor implemented the requested code block formatting for the Flask, Django, and FastAPI tutorials.
qwen/qwen3.6-35b-a3b Documentation formatting request fixed. Inline run instructions for Flask, Django, and FastAPI tutorials were moved into code blocks. The issue closed after another contributor implemented the changes.
qwen/qwen3.6-35b-a3b Documentation formatting was updated to place Flask, Django, and FastAPI run instructions in code blocks. The request was resolved and the issue closed after the assigned contributor applied the changes.
qwen3.6-35b-a3b-mtp-q6 Closed and handed off to contributor @zlplzp123wyt. The documentation fix to wrap Flask, Django, and FastAPI run instructions in code blocks is being implemented separately.
qwen3.6-35b-a3b-mtp-q6
Staleness: 55
Complexity: 10
Confidence: 85
Support Request: 5
keep open Update Rockcraft tutorials for Flask, Django, and FastAPI to format app run instructions as code blocks instead of inline text. Currently being worked on by @zlplzp123wyt.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1147 docs: Running Flask, Django and FastAPI should be in a code block rockcraft merged Merged after resolving a documentation conflict and verifying contributor CLA status. Changes convert inline Flask, Django, and FastAPI run commands to code blocks, improving readability and consistency. Approved by four reviewers with all CI checks passing.
85%
#1191 docs: put run-the-app instructions in their own code block rockcraft merged Merged documentation update moving run-the-app commands for Flask, Django, and FastAPI tutorials to dedicated bash code blocks for consistency. Resolves #1145. Spread tests remain unchanged as they already verify execution.
72%