pre-commit-ci[bot]
3242cd89a5
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
2 weeks ago
Nils Lindemann
5f02331605
Changes to German prompt reflecting results from batch translation
* (Hopefully) improve rule when not to convert to typographic quotation marks, re-add some examples
* Refine rule how to translate abbr elements
* Include and remove some words
2 weeks ago
Nils Lindemann
38d36bb34b
Two Fixes in English documents
Fond these while manually checking the previous batch translation commit
2 weeks ago
Nils Lindemann
5e270ac1ec
German docs batch translation
A complete run through the German docs to test how the prompts work "in production".
gpt-5 found a lot of things which gpt-4o and I have overlooked.
I had to manually modify/fix approximately 10 changes it suggested, which is a good result for 111 files.
The German docs are now completely translated and in sync.
2 weeks ago
Nils Lindemann
2170725397
Prepare translate.py for Batch translation
... making a few fixes/changes:
* Fix a deprecation warning
* Fix a probably not intended hardcoded "es" language identifier when calling `translate_page`
* Fix `iter_en_paths_to_translate` and `non_translated_sections ` to also work on Windows, which uses backslashes in stringified paths
* Add `mode`, `verbose` and `preview` parameters to `translate_lang`, add a helper function to print path infos, and improve its output to show the progress.
* Add documentation to some function parameters
2 weeks ago
Nils Lindemann
d3a5d05655
Intermezzo `z.B.` --> `z. B.`
Forgot to include the change to the German prompt. It is in the later commit.
2 weeks ago
Nils Lindemann
0aa33f5f03
Update tutorial/security/oauth2-jwt.md
Done with the manual walkthrough.
My final temporary git ignore additions (to hide files in VSCode) may be of interest:
# Temporarily ignore unrelated files
/*
!/docs
/docs/*
!/docs/en
!/docs/de
/docs/*/*
!/docs/*/docs
/docs/*/docs/css
/docs/*/docs/img
/docs/*/docs/js
/docs/*/docs/reference
/docs/*/docs/release-notes.md
/docs/*/docs/fastapi-people.md
/docs/*/docs/external-links.md
/docs/*/docs/newsletter.md
/docs/*/docs/management-tasks.md
/docs/*/docs/management.md
/docs/*/docs/contributing.md
# Temporarily ignore done files
/docs/*/docs/alternatives.md
/docs/*/docs/async.md
/docs/*/docs/benchmarks.md
/docs/*/docs/environment-variables.md
/docs/*/docs/fastapi-cli.md
/docs/*/docs/features.md
/docs/*/docs/help-fastapi.md
/docs/*/docs/history-design-future.md
/docs/*/docs/index.md
/docs/*/docs/project-generation.md
/docs/*/docs/python-types.md
/docs/*/docs/virtual-environments.md
/docs/*/docs/about/index.md
/docs/*/docs/about
/docs/*/docs/advanced/additional-responses.md
/docs/*/docs/advanced/additional-status-codes.md
/docs/*/docs/advanced/advanced-dependencies.md
/docs/*/docs/advanced/async-tests.md
/docs/*/docs/advanced/behind-a-proxy.md
/docs/*/docs/advanced/custom-response.md
/docs/*/docs/advanced/dataclasses.md
/docs/*/docs/advanced/events.md
/docs/*/docs/advanced/generate-clients.md
/docs/*/docs/advanced/index.md
/docs/*/docs/advanced/middleware.md
/docs/*/docs/advanced/openapi-callbacks.md
/docs/*/docs/advanced/openapi-webhooks.md
/docs/*/docs/advanced/path-operation-advanced-configuration.md
/docs/*/docs/advanced/response-change-status-code.md
/docs/*/docs/advanced/response-cookies.md
/docs/*/docs/advanced/response-directly.md
/docs/*/docs/advanced/response-headers.md
/docs/*/docs/advanced/settings.md
/docs/*/docs/advanced/sub-applications.md
/docs/*/docs/advanced/templates.md
/docs/*/docs/advanced/testing-dependencies.md
/docs/*/docs/advanced/testing-events.md
/docs/*/docs/advanced/testing-websockets.md
/docs/*/docs/advanced/using-request-directly.md
/docs/*/docs/advanced/websockets.md
/docs/*/docs/advanced/wsgi.md
/docs/*/docs/advanced/security/http-basic-auth.md
/docs/*/docs/advanced/security/index.md
/docs/*/docs/advanced/security/oauth2-scopes.md
/docs/*/docs/advanced/security
/docs/*/docs/advanced
/docs/*/docs/deployment/cloud.md
/docs/*/docs/deployment/concepts.md
/docs/*/docs/deployment/docker.md
/docs/*/docs/deployment/https.md
/docs/*/docs/deployment/index.md
/docs/*/docs/deployment/manually.md
/docs/*/docs/deployment/server-workers.md
/docs/*/docs/deployment/versions.md
/docs/*/docs/deployment
/docs/*/docs/how-to/conditional-openapi.md
/docs/*/docs/how-to/configure-swagger-ui.md
/docs/*/docs/how-to/custom-docs-ui-assets.md
/docs/*/docs/how-to/custom-request-and-route.md
/docs/*/docs/how-to/extending-openapi.md
/docs/*/docs/how-to/general.md
/docs/*/docs/how-to/graphql.md
/docs/*/docs/how-to/index.md
/docs/*/docs/how-to/separate-openapi-schemas.md
/docs/*/docs/how-to/testing-database.md
/docs/*/docs/how-to
/docs/*/docs/learn/index.md
/docs/*/docs/learn
/docs/*/docs/resources/index.md
/docs/*/docs/resources
/docs/*/docs/tutorial/background-tasks.md
/docs/*/docs/tutorial/bigger-applications.md
/docs/*/docs/tutorial/body-fields.md
/docs/*/docs/tutorial/body-multiple-params.md
/docs/*/docs/tutorial/body-nested-models.md
/docs/*/docs/tutorial/body-updates.md
/docs/*/docs/tutorial/body.md
/docs/*/docs/tutorial/cookie-param-models.md
/docs/*/docs/tutorial/cookie-params.md
/docs/*/docs/tutorial/cors.md
/docs/*/docs/tutorial/debugging.md
/docs/*/docs/tutorial/encoder.md
/docs/*/docs/tutorial/extra-data-types.md
/docs/*/docs/tutorial/extra-models.md
/docs/*/docs/tutorial/first-steps.md
/docs/*/docs/tutorial/handling-errors.md
/docs/*/docs/tutorial/header-param-models.md
/docs/*/docs/tutorial/header-params.md
/docs/*/docs/tutorial/index.md
/docs/*/docs/tutorial/metadata.md
/docs/*/docs/tutorial/middleware.md
/docs/*/docs/tutorial/path-operation-configuration.md
/docs/*/docs/tutorial/path-params-numeric-validations.md
/docs/*/docs/tutorial/path-params.md
/docs/*/docs/tutorial/query-param-models.md
/docs/*/docs/tutorial/query-params-str-validations.md
/docs/*/docs/tutorial/query-params.md
/docs/*/docs/tutorial/request-files.md
/docs/*/docs/tutorial/request-form-models.md
/docs/*/docs/tutorial/request-forms-and-files.md
/docs/*/docs/tutorial/request-forms.md
/docs/*/docs/tutorial/response-model.md
/docs/*/docs/tutorial/response-status-code.md
/docs/*/docs/tutorial/schema-extra-example.md
/docs/*/docs/tutorial/sql-databases.md
/docs/*/docs/tutorial/static-files.md
/docs/*/docs/tutorial/testing.md
/docs/*/docs/tutorial/dependencies/index.md
/docs/*/docs/tutorial/dependencies/classes-as-dependencies.md
/docs/*/docs/tutorial/dependencies/sub-dependencies.md
/docs/*/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md
/docs/*/docs/tutorial/dependencies/global-dependencies.md
/docs/*/docs/tutorial/dependencies/dependencies-with-yield.md
/docs/*/docs/tutorial/dependencies
/docs/*/docs/tutorial/security/index.md
/docs/*/docs/tutorial/security/first-steps.md
/docs/*/docs/tutorial/security/get-current-user.md
/docs/*/docs/tutorial/security/simple-oauth2.md
/docs/*/docs/tutorial/security/oauth2-jwt.md
/docs/*/docs/tutorial/security
/docs/*/docs/tutorial
/docs/*/docs
/docs/*
/docs
2 weeks ago
Nils Lindemann
aac2e8c04c
Update tutorial/security/simple-oauth2.md
Forgot the `tutorial/` in the messages of the two previous `Update` commits, but it was already pushed. Sorry about that.
2 weeks ago
Nils Lindemann
f31c8bda0d
Update security/get-current-user.md
2 weeks ago
Nils Lindemann
376e580a04
Intermezzo: `Es testen` --> `Testen`
LLM insists on writing it like this and I am fine with it. It is also written like this in the `/// check | Testen` blocks.
2 weeks ago
Nils Lindemann
26cc7f4c8b
Update security/first-steps.md
2 weeks ago
Nils Lindemann
2aa290af50
Intermezzo - Explain conversion of quotation marks different
because I have the impression that it uses the '``' in the second example and therefore does not see them.
2 weeks ago
Nils Lindemann
c6eec13a2c
Intermezzo: You --> you
Fix a missing space on the way
2 weeks ago
Nils Lindemann
06c1fe89f1
Update tutorial/security/index.md
2 weeks ago
Nils Lindemann
a39d69c84a
Update dependencies/dependencies-with-yield.md
It not just kept the translations in the Mermaid diagram (as told) but also updated/fixed them and removed a line of code which was gone in the English diagram.
And fixed/updated many other things. Not one unnecessary change.
2 weeks ago
Nils Lindemann
e0a805e796
Update dependencies/global-dependencies.md
2 weeks ago
Nils Lindemann
9cebcf0f8e
Update dependencies/dependencies-in-path-operation-decorators.md
2 weeks ago
Nils Lindemann
9eb82ee0f0
Update tutorial/dependencies/sub-dependencies.md + general prompt
2 weeks ago
Nils Lindemann
64cb2e2e49
Update tutorial/dependencies/classes-as-dependencies.md
2 weeks ago
Nils Lindemann
d2759667d7
Update tutorial/dependencies/index.md + prompt
Starting with this commit and in the remaining two folders, I translate the documents in the order they appear in the documentation. Should have done that from the beginning, as it helps the LLM learning things (I guess).
2 weeks ago
Nils Lindemann
b9b80e3989
Update tutorial/testing.md
2 weeks ago
Nils Lindemann
f2a70af828
Update tutorial/static-files.md + prompt
2 weeks ago
Nils Lindemann
a1aecf53d8
Update tutorial/sql-databases.md
2 weeks ago
Nils Lindemann
7c302a51ca
Update tutorial/schema-extra-example
2 weeks ago
Nils Lindemann
ef77c611c8
Update tutorial/response-status-code.md
2 weeks ago
Nils Lindemann
6f1102320c
Update tutorial/response-model.md
I created this before with GPT-4o, twice as much changes, plus it did not understand some of my rule definitons (Though the prompt was different). So I reverted everything and tried the same with GPT-5. This diff is a joy, only the relevant changes.
2 weeks ago
Nils Lindemann
1941c610ee
Intermezzo: Use GPT-5
This commit started as an attempt to handle translation of abbr elements, which I was not able to get to work in a clean way. Shortly before I resigned I had the idea to try `openai:gpt-5` as agent in the translate.py, instead of `openai:gpt-4o` and BAM it worked. A lot of other things also worked much better. Modifications had to be made though because GPT-5 interpreted some rules stricter, so some reformulation and some more examples were needed. Will translate with that agent in the remaining translations to test if these prompts work well.
2 weeks ago
Nils Lindemann
69255ea21d
Intermezzo: Undo changes in two English documents
I guess these html elements were used purposefully because of rendering issues.
2 weeks ago
Nils Lindemann
e26ab3d108
Update tutorial/request-forms.md + prompt
2 weeks ago
Nils Lindemann
e3697650f6
Update tutorial/request-forms-and-files.md
2 weeks ago
Nils Lindemann
0dca3808e5
Update tutorial/request-form-models.md
2 weeks ago
Nils Lindemann
5817acdfb0
Update tutorial/request-files.md + prompt
Also resort promp slightly and replace a code element with backticks in the English document.
2 weeks ago
Nils Lindemann
59e4ad79cb
Intermezzo: Tell LLM to not add anchors to links
As it did so once (like in the example). This is actually super smart, the anchor exists (is the LLM caching the Anchors of headings in other documents?!), but I guess this possibly creates confusion, so avoid.
2 weeks ago
Nils Lindemann
b3634502df
Update tutorial/query-params.md + Prompt
The LLM wrote `Pfadparameter`, which is not bad, but let's use or not use a dash unison for all FastAPI specific path operation parameters. As the translation so far used one, I now defined it to be so.
2 weeks ago
Nils Lindemann
da838cf072
Update tutorial/query-params-str-validations.md
2 weeks ago
Nils Lindemann
88b2135b4e
Update tutorial/query-param-models.md
2 weeks ago
Nils Lindemann
df6e086b1c
Update tutorial/path-params.md
2 weeks ago
Nils Lindemann
7a5167a181
Update tutorial/path-params-numeric-validations.md + prompt
There are some instances of using `<code>...</code>` instead of backticks in the English document, which I fixed on the way, as it will not require a retranslation of other languages.
2 weeks ago
Nils Lindemann
41fcf98995
Update tutorial/path-operation-configuration.md
2 weeks ago
Nils Lindemann
e9ac883a7e
Intermezzo: Format examples like in the general prompt
Removes one level of Use–mention distinction [1] by writing the examples in separate paragraphs, instead of wrapping them in backticks. This because the LLM still seems to ignore the rules sometimes, here it ignored the rule to translate the content of title attribute of abbr elements.
[1]: https://en.wikipedia.org/wiki/Use%E2%80%93mention_distinction
2 weeks ago
Nils Lindemann
79971b613c
Update tutorial/middleware.md
2 weeks ago
Nils Lindemann
691a61d300
Update tutorial/metadata.md + prompt
2 weeks ago
Nils Lindemann
93d7fe9082
Update tutorial/index.md
2 weeks ago
Nils Lindemann
8a937e7b76
update tutorial/header-params.md + prompt
2 weeks ago
Nils Lindemann
8128fcb5ad
Update tutorial/header-param-models.md
2 weeks ago
Nils Lindemann
4371ad3a01
Update tutorial/handling-errors.md
2 weeks ago
Nils Lindemann
14f1e7b4a0
Update tutorial/first-steps.md
2 weeks ago
Nils Lindemann
57924f30d3
Update tutorial/extra-models.md
2 weeks ago
Nils Lindemann
cbeb41d832
Update tutorial/extra-data-types.md
2 weeks ago
Nils Lindemann
faf95d1c82
Update tutorial/encoder.md
2 weeks ago