Skip to content

✏️ Documentation tweaks#10985

Closed
nilslindemann wants to merge 30 commits intofastapi:masterfrom
nilslindemann:docs-tweaks
Closed

✏️ Documentation tweaks#10985
nilslindemann wants to merge 30 commits intofastapi:masterfrom
nilslindemann:docs-tweaks

Conversation

@nilslindemann
Copy link
Copy Markdown
Contributor

@nilslindemann nilslindemann commented Jan 17, 2024

This PR is huge, I am sorry. But I am also happy that it's done.

These are things which I have changed/fixed in locations outside the German docs, while I translated it. The commit comments contain detailed descriptions.

I am pretty sure of all commits, except the last two:

Nils Lindemann added 20 commits January 17, 2024 19:30
These were added to the Englisch docs in fastapi#10392.

I went through all instances of:

* docs/index.md
* docs/features.md
* docs/fastapi-people.md

in the rest of the docs and added this where missing. The PRs for the German translations (fastapi#10283, fastapi#10284, fastapi#10285) already contain this change.
I searched case sensitive under `./docs/`with the regex `!!! (?!tip|note|info|warning|danger|check)`.
Includes only the links where i just removed the `./` from the start and did nothing else.

I checked this and the links in the next commits with a script, see `linkchecker.py` in the `scripts/` commit in my workbranch (fastapi#10854). That script checks if local links (including images and python code files) are valid and well-formed. It also suggests hash parts of links that can possibly be translated.
Makes it simpler for translators to find a file.

Also contains one link (sql-databases.md) where the `./` is stripped from the start.
The linkchecker script helped me with these. I also checked each link manually.

Also applies the changes from the two previous commits to a few links.
Mkdocs complains about them.
Also apply changes from the previous four commits to some of them.
If I understand right, this is the format of such links.
Just a few, did not systematically check all.
Leads to a better overview.
@nilslindemann nilslindemann changed the title Documentation tweaks ✏️ Documentation tweaks Jan 17, 2024
@tiangolo
Copy link
Copy Markdown
Member

📝 Docs preview for commit 049af7e at: https://d82e5064.fastapitiangolo.pages.dev

@tiangolo tiangolo added docs Documentation about how to use FastAPI p2 labels Jan 21, 2024
@tiangolo
Copy link
Copy Markdown
Member

📝 Docs preview for commit ae4e07e at: https://64fe80d8.fastapitiangolo.pages.dev

linkchecker.py suggests these.
@tiangolo
Copy link
Copy Markdown
Member

📝 Docs preview for commit 7393082 at: https://9dd9cf04.fastapitiangolo.pages.dev

@alejsdev alejsdev self-assigned this Feb 2, 2024
@tiangolo
Copy link
Copy Markdown
Member

tiangolo commented Feb 3, 2024

📝 Docs preview for commit f656152 at: https://2b3af993.fastapitiangolo.pages.dev

According to linkchecker.py. I also checked manually.
@tiangolo
Copy link
Copy Markdown
Member

tiangolo commented Feb 4, 2024

📝 Docs preview for commit 69ae1ff at: https://8abed4a5.fastapitiangolo.pages.dev

Nils Lindemann added 2 commits February 20, 2024 21:33
according to linkchecker.py (also manually tested)
@tiangolo
Copy link
Copy Markdown
Member

📝 Docs preview for commit 050e2fb at: https://9564556a.fastapitiangolo.pages.dev

@tiangolo
Copy link
Copy Markdown
Member

tiangolo commented Apr 1, 2024

📝 Docs preview for commit 6767c3c at: https://5f9b75cb.fastapitiangolo.pages.dev

Found by linkchecker.py
@tiangolo
Copy link
Copy Markdown
Member

tiangolo commented Apr 1, 2024

📝 Docs preview for commit 3d0da80 at: https://ddccf36f.fastapitiangolo.pages.dev

@nilslindemann
Copy link
Copy Markdown
Contributor Author

nilslindemann commented Apr 1, 2024

@alejsdev Dammit, I anyhow effed things up in this commit. There were things removed which exist in the main branch. I am currently not grasping what happened here, so I will close and recreate this PR, and while doing this, I will look how I can make this simpler to review. I hope you did not already invest time in reviewing. If so, sorry. If no, congrats for solving a problem by avoiding it ^^

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 p2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants