Skip to content

[DOCS] update docs#57

Merged
bnbong merged 2 commits intomainfrom
dev
May 6, 2026
Merged

[DOCS] update docs#57
bnbong merged 2 commits intomainfrom
dev

Conversation

@bnbong
Copy link
Copy Markdown
Owner

@bnbong bnbong commented May 6, 2026

Requesting Merging

Description

Part of #41
Closes #47
Closes #48
Closes #49
Refs #50

This PR completes the current documentation work for v1.3.0 around starter selection, the fastapi-domain-starter onboarding experience, and translation transparency.

The main goal is to make FastAPI-fastkit easier to choose, easier to understand after generation, and more trustworthy in multilingual docs by clearly stating that English is the source of truth and that translated locales may be partial or fall back to English.

Type of Change

  • BUG FIX
  • ADDING NEW TEMPLATE
  • FEATURE ADDED/UPDATED
  • HOTFIX
  • DELETING UNNECESSARY FEATURES
  • DOCUMENTATION & DEVOPS
  • Etc..

Test Environment

  • Local macOS (Apple Silicon / M1), zsh
  • Python via uv
  • Verified command:
    • uv run mkdocs build
    • Result: Documentation built in 15.88 seconds

Major Changes

  • Added a new beginner-facing starter selection guide

    • docs/en/user-guide/choosing-a-starter.md
    • Explains:
      • startdemo vs init --interactive
      • the four architecture presets
      • when to choose each starter path
      • which option is the recommended modern default
  • Added a dedicated fastapi-domain-starter tutorial

    • docs/en/tutorial/domain-starter.md
    • Covers:
      • generated project tree
      • the role of core, db, api, domains, and tests
      • the bundled items example
      • how to add the next domain/module
    • Linked from:
      • docs home
      • starter selection guide
      • fastapi-domain-starter template README
  • Added translation transparency and source-of-truth policy

    • docs/en/reference/translation-status.md
    • docs/en/contributing/translation-guide.md
    • Documents:
      • English as the canonical source of truth
      • fallback-to-English behavior
      • per-locale completeness expectations
      • contributor expectations for partial translations
  • Added translation status notices to landing pages

    • docs/en/index.md
    • docs/ko/index.md
    • Makes it explicit that translated pages may be partial and that English should be trusted when pages disagree
  • Updated docs navigation and entry points

    • Added:
      • Choosing a Starter
      • Domain-oriented Project (Domain Starter)
      • Translation Status
    • Updated README links to surface the new docs earlier
  • Kept existing docs aligned with current CLI behavior

    • Refreshed output examples and interactive-init guidance
    • Preserved continuity with the earlier Korean interactive docs fix tracked in #50

Screenshots (optional)

N/A

Etc

  • This PR is documentation-focused and does not change runtime product behavior.
  • The new translation policy/docs are intended to support the next Korean translation batch work for v1.3.0.

@bnbong bnbong added this to the v1.3.0 milestone May 6, 2026
@bnbong bnbong self-assigned this May 6, 2026
@bnbong bnbong added documentation Improvements or additions to documentation template Add or editing a FastAPI template labels May 6, 2026
@bnbong
Copy link
Copy Markdown
Owner Author

bnbong commented May 6, 2026

@codex review

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

Template Inspection Passed

All changed templates have been validated successfully.


Last updated: 2026-05-06T05:29:22.465Z

@codecov
Copy link
Copy Markdown

codecov Bot commented May 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep it up!

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@bnbong bnbong merged commit f6192b5 into main May 6, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation template Add or editing a FastAPI template

Projects

None yet

1 participant