Skip to content
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

docs: Remove manual tables of content #2921

Merged
merged 1 commit into from
Sep 27, 2024
Merged

docs: Remove manual tables of content #2921

merged 1 commit into from
Sep 27, 2024

Conversation

jplatte
Copy link
Member

@jplatte jplatte commented Sep 20, 2024

docs.rs now generates these:

Screenshot 2024-09-20 at 22-17-27 axum - Rust

@jplatte jplatte marked this pull request as ready for review September 20, 2024 20:32
@jplatte jplatte enabled auto-merge (squash) September 20, 2024 20:32
Copy link
Collaborator

@mladedav mladedav left a comment

Choose a reason for hiding this comment

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

Looks good. If you want the changelog to contain the entry, feel free to merge as is.

EDIT, oh, it was set to auto-merge. That settles it then 😀

Comment on lines +11 to +12
- **change**: Remove manual tables of content from the documentation, since
rustdoc now generates tables of content in the sidebar ([#2921])
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we want this in the changelog? If users upgrading to a new version is the intended audience, I'm not sure this is something they need to know.

Otherwise I don't know who the intended audience is or if we want all, even infrastructure changes, to be in the changelog.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah it's not really necessary but I'd like to make a patch release with this and I think empty / no changelogs are not nice.

@jplatte jplatte merged commit 0a0e438 into main Sep 27, 2024
18 checks passed
@jplatte jplatte deleted the jplatte/rm-manual-tocs branch September 27, 2024 19:16
jplatte added a commit that referenced this pull request Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants