Skip to content

Conversation

@clux
Copy link
Member

@clux clux commented Sep 21, 2025

watched a talk on docs.rs features and thought to try a few things.

  • add a logo to the lhs of the docs.rs/kube page
    • logo url is the same as from webpage index
  • documenting features, linking to kube.rs/features
    • tried document-features dep, but found it nicer to link to kube.rs because it didn't look very nice in docs.rs)
    • left my new document-features compatible feature comments in the kube/cargo toml file though since it looks helpful
  • adding an informer alias so that people that search for informer land on watcher

also fixes up ci issue on hashbrown duplicate so bumping

Looks

logo
grim-area-2025-09-21-21_38_14

alias
grim-area-2025-09-21-21_40_01

- documenting features, linking to kube.rs/features
- adding an informer alias so that people that search for informer land on watcher
- add a logo to the lhs of the docs.rs/kube page

Signed-off-by: clux <[email protected]>
@nightkr
Copy link
Member

nightkr commented Sep 21, 2025

tried document-features dep, but found it nicer to link to kube.rs because it didn't look very nice in docs.rs)

So I can't comment on document-features per-se, but one very important (IMO) upside of keeping this sort of reference stuff inside of rustdoc is that it follows the same versioning as the crate itself. So a year later, we can all still come back and see what the feature flags of v2.1.0 (or whatever) were, not just v4.0.0-or-whatever-is-current-then.

@clux
Copy link
Member Author

clux commented Sep 21, 2025

one very important (IMO) upside of keeping this sort of reference stuff inside of rustdoc is that it follows the same versioning as the crate itself. So a year later, we can all still come back and see what the feature flags of v2.1.0 (or whatever) were, not just v4.0.0-or-whatever-is-current-then.

yeah. we're not really taking anything new out of rustdoc. we can still see features per version. it's just having an inlined table in the main generated doc turned out not to be so nice due to lacking link support and stuff. the kube.rs/features doc is more expanding on what does what and what you turn off. i realise that has the potential to get out of date, but so does everything on the website (:

@clux clux marked this pull request as ready for review October 9, 2025 23:26
@clux clux changed the title docs.rs updates docs.rs updates + feature docs + hashbrown bump Oct 9, 2025
@clux
Copy link
Member Author

clux commented Oct 9, 2025

ugh, coverage still a bit broken on the trybuild issue. it works locally. will try out more in ci later. merging for now to get less things failing.

@clux clux merged commit 4602b50 into main Oct 9, 2025
15 of 16 checks passed
@clux clux deleted the doc-attrs branch October 9, 2025 23:28
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.

2 participants