docs: align FastAPI tutorial structure with Django tutorial
Metadata
Current evaluation
Merged after the contributor signed the CLA and rebased to hotfix/3.5. Aligns FastAPI tutorial structure with Django, fixes typos, and standardizes headings. Updates will appear in the next Charmcraft patch release.
Suggested action: —
No scores available.
Issue body
Closes [Charmcraft FastAPI tutorial: Add structure to sections #208](https://github.com/canonical/open-documentation-academy/issues/208)
- Inserted "The development cycle" section after "Deploy the FastAPI app", and split the existing content under new subheadings.
- Added an "Introduction" heading below the main title, and changed the subsequent two headings into subheadings to match Django's tutorial structure
- Fixed typo: "Deplyoing" -> "Deploying".
- Changed "Hello World" to "Hello, world!" for consistency inside the FastAPI tutorial, and alignment with the Django tutorial.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged after the contributor signed the CLA and rebased to hotfix/3.5. Aligns FastAPI tutorial structure with Django, fixes typos, and standardizes headings. Updates will appear in the next Charmcraft patch release. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after the contributor signed the CLA and rebased onto hotfix/3.5. Aligns FastAPI tutorial structure with Django, fixes typos, and standardizes headings. Updates will appear in the next Charmcraft patch release. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after the contributor signed the CLA and rebased to hotfix/3.5. Aligns FastAPI tutorial structure with Django, fixes typos, and standardizes headings. Updates will appear in the next Charmcraft patch release. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1330 docs: Update FastAPI tutorial to remove chiselling section | rockcraft | merged | Merged documentation update removing an outdated FastAPI tutorial chiselling section, as the extension now defaults to the bare base. The contributor was blocked by a broken security scan workflow until PR #1324 resolved the issue, allowing final merge. | |
| #2440 docs: align Flask tutorial structure with Django tutorial | charmcraft | merged | Aligns Flask tutorial structure with Django tutorial through section reorganization, added introductory text, and typo fixes. Approved by three reviewers and merged after passing CI checks. | |
| #1151 docs: remove redundant chiselling steps from Flask and Django tutorials | rockcraft | merged | Merged docs update removing redundant chiselling steps from Flask and Django tutorials. Clarified base: bare already produces a chiselled rock. FastAPI unchanged. Approved and merged as a partial fix for #1143. | |
| #2439 docs: align Flask tutorial structure with Django tutorial | charmcraft | closed | Closed without merging. The Flask tutorial documentation update was abandoned due to lack of reviewer engagement and failing CI checks. No changes were applied. |