Skip to content

📝 Swap install and run code sections order in docs/tutorial/index.md #13680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

liby
Copy link

@liby liby commented May 3, 2025

Description

This PR changes the order of sections in the tutorial index files across multiple language translations. It moves the "Install FastAPI" section before the "Run the code" section, which is more logical since users need to install FastAPI before they can run any code examples.

Changes

  • Reordered sections in docs/tutorial/index.md files for the following languages:
    • English (en)
    • Simplified Chinese (zh)
    • Traditional Chinese (zh-hant)
    • Spanish (es)
    • German (de)
    • Portuguese (pt)
    • Indonesian (id)
    • Japanese (ja)
    • Korean (ko)
    • Polish (pl)
    • Russian (ru)
    • Ukrainian (uk)
    • Vietnamese (vi)
    • Emoji version (em)
    • French (fr)

Motivation

The original order was inconsistent with the natural flow of onboarding new users. It makes more sense to first explain how to install FastAPI before showing users how to run code examples, as installation is a prerequisite for running the code.

Checklist

  • I have read the Contributing Guide
  • Documentation content is consistent across all translations
  • No code examples were modified, only the section order

@github-actions github-actions bot added the docs Documentation about how to use FastAPI label May 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation about how to use FastAPI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy