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

Tracking issue for release notes of #120736: rustdoc: add header map to the table of contents #129964

Open
3 tasks
rustbot opened this issue Sep 4, 2024 · 1 comment
Labels
relnotes Marks issues that should be documented in the release notes of the next release. relnotes-tracking-issue Marks issues tracking what text to put in release notes.
Milestone

Comments

@rustbot
Copy link
Collaborator

rustbot commented Sep 4, 2024

This issue tracks the release notes text for #120736.

  • Proposed text is drafted by PR author (or team) making the noteworthy change.
  • Issue is nominated for release team review of clarity for wider audience.
  • Release team includes text in release notes/blog posts.

Release notes text:

The responsible team for the underlying change should edit this section to replace the
automatically generated link with a succinct description of what changed, drawing upon text
proposed by the author (either in discussion or through direct editing). If the change is notable
enough for inclusion in the blog post, add content to the blog section below.

# Rustdoc
- [The sidebar / hamburger menu table of contents now includes the
  `# headers` from the main item's doc comment](https://github.com/rust-lang/rust/pull/120736).
  This is similar to a third-party feature provided by the
  rustdoc-search-enhancements browser extension.

Note: The section title will be de-duplicated by the release team with other release notes issues.
Please use a standard title from previous releases.
More than one section can be included if needed.

Release blog section (if any, leave blank if no section is expected):

cc @notriddle, @GuillaumeGomez -- origin issue/PR authors and assignees for starting to draft text

@rustbot rustbot added relnotes Marks issues that should be documented in the release notes of the next release. relnotes-tracking-issue Marks issues tracking what text to put in release notes. needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Sep 4, 2024
@notriddle
Copy link
Contributor

notriddle commented Sep 4, 2024

I don't think this needs mentioned in the blog. In the release notes, I would say something like:

# Rustdoc
- [The sidebar / hamburger menu table of contents now includes the
  `# headers` from the main item's doc comment](https://github.com/rust-lang/rust/pull/120736).
  This is similar to a third-party feature provided by the
  rustdoc-search-enhancements browser extension.

@saethlin saethlin removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Sep 4, 2024
@rustbot rustbot added this to the 1.83.0 milestone Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
relnotes Marks issues that should be documented in the release notes of the next release. relnotes-tracking-issue Marks issues tracking what text to put in release notes.
Projects
None yet
Development

No branches or pull requests

3 participants