docs: align FastAPI tutorial structure with Django tutorial
Metadata
Current evaluation
Merged PR #2287 into hotfix/3.5, aligning the FastAPI tutorial with Django, adding development-cycle sections, correcting “Deplyoing,” and standardizing “Hello, world!”
Resolution: closed resolved
Reason: Maintainer @lengau confirmed on 2025-06-26 that PR #2287 was merged after it was retargeted to hotfix/3.5. The documentation changes were expected in the next Charmcraft patch release.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2287 into hotfix/3.5, aligning the FastAPI tutorial with Django, adding development-cycle sections, correcting “Deplyoing,” and standardizing “Hello, world!” | |
| stealth/space-bunny-alpha | — | closed resolved | Merged into hotfix/3.5 via commit 647a1bbf, aligning the FastAPI tutorial with Django and fixing a deployment typo; the changes were slated for the next patch release. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged into hotfix/3.5, aligning FastAPI tutorial sections with Django and fixing “Deplyoing”; maintainers said the docs would ship in Charmcraft’s next patch release. | |
| 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. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
open-documentation-academy#208
(confidence 100%)
PR #2287 explicitly closes the request to add structure to the FastAPI tutorial sections.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2440 docs: align Flask tutorial structure with Django tutorial | charmcraft | merged | Merged PR #2440 as commit c7a7118b, aligning the Flask tutorial with the Django structure, adding a development-cycle section, reorganizing subsections, and fixing copy errors. | |
| #1330 docs: Update FastAPI tutorial to remove chiselling section | rockcraft | merged | Docs PR #1330 merged as commit eef25f2e, deleting the obsolete FastAPI chiselling tutorial section since the FastAPI extension now defaults to the bare base (2 files, +2/-130). | |
| #2179 Added some further structure to the Django tutorial | charmcraft | merged | Merged PR #2179 added headings emphasizing the Django tutorial’s cyclical develop/pack/deploy workflow; changes landed in commit 2d26e5c7. | |
| #1145 docs: Running Flask, Django and FastAPI should be in a code block | rockcraft | closed | Fixed the Flask, Django and FastAPI tutorials in PR #1191 (commit 32291e2a), giving app-run instructions dedicated code blocks. |