add doc comments

crates/valence_equipment/src/lib.rs

@@ -36,6 +36,12 @@ impl Plugin for EquipmentPlugin {
     }
 }
 
+/// Contains the visible equipment of a [`LivingEntity`], such as armor and held
+/// items. By default this is not synced with a player's [`Inventory`], so the
+/// armor the player has equipped in their inventory, will not be visible by
+/// other players. You would have to change the equipment in this component here
+/// or attach the [`EquipmentInventorySync`] component to the player
+/// entity to sync the equipment with the inventory.
 #[derive(Debug, Default, Clone, Component)]
 pub struct Equipment {
     equipment: [ItemStack; Self::SLOT_COUNT],