Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

YuriiMotov
Copy link
Contributor

@YuriiMotov YuriiMotov commented Sep 1, 2025

Add missing permalinks to all En docs:

typer scripts/docs.py run add-permalinks`

Re-generate permalinks for all En docs:

typer scripts/docs.py run add-permalinks --update-existing

Add missing permalinks to specific page in En docs:

typer scripts/docs.py run add-permalinks-page docs/en/docs/advanced/behind-a-proxy.md

At the moment we have 1 missed permalink (I committed it an then reverted): 6bf43ba

Can we fix it in this PR or should I open separate PR for this?


Also, I don't know if we need to add some logging?

@github-actions github-actions bot added the docs Documentation about how to use FastAPI label Sep 1, 2025

This comment was marked as outdated.

@YuriiMotov YuriiMotov removed the docs Documentation about how to use FastAPI label Sep 1, 2025
Copy link
Contributor

github-actions bot commented Sep 1, 2025

📝 Docs preview for commit 9519da0 at: https://1ff1c479.fastapitiangolo.pages.dev

Copy link
Member

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How will we keep things up-to-date, will this script run on Github actions when a PR changes/adds documentation?

@YuriiMotov
Copy link
Contributor Author

How will we keep things up-to-date, will this script run on Github actions when a PR changes/adds documentation?

Yes, it's supposed to be used by GitHub actions

@svlandeg
Copy link
Member

svlandeg commented Sep 2, 2025

Then I wouldn't worry about the one missing link, and let the script deal with it on the next update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants