update some docs

Author: sachaarbonel

packages/stream_feed_flutter_core/lib/src/bloc/feed_bloc.dart

@@ -10,6 +10,21 @@ import 'package:stream_feed_flutter_core/src/extensions.dart';
 ///
 /// [GenericFeedBloc] can be access at anytime by using the factory [of] method
 /// using Flutter's [BuildContext].
+/// 
+/// Usually what you want is the convenient [FeedBloc] that already 
+/// has the default parameters defined for you
+/// suitable to most use cases
+/// 
+/// ## Usage
+/// - query activities
+/// - query reactions (like, retweet, claps)
+/// - add activities (a tweet for example)
+/// - remove activities (delete a tweet)
+/// - add reactions (comment under a tweet)
+/// - remove reacitons (delete a comment under a tweet)
+/// - add child reactions (like to a comment)
+/// - remove child reacitons (unlike a comment)
+
 class GenericFeedBloc<A, Ob, T, Or> {
   GenericFeedBloc({required this.client, this.analyticsClient});
 

packages/stream_feed_flutter_core/lib/src/bloc/provider.dart

@@ -5,6 +5,7 @@ import 'package:stream_feed_flutter_core/src/bloc/feed_bloc.dart';
 /// Inherited widget providing the [GenericFeedBloc] to the widget tree
 /// Usually what you need is the convenient [FeedProvider] that already 
 /// has the default parameters defined for you
+/// suitable to most usecases
 class GenericFeedProvider<A, Ob, T, Or> extends InheritedWidget {
   const GenericFeedProvider({
     Key? key,

packages/stream_feed_flutter_core/lib/src/flat_feed_core.dart

@@ -7,36 +7,15 @@ import 'package:stream_feed_flutter_core/src/states/states.dart';
 import 'package:stream_feed_flutter_core/src/typedefs.dart';
 import 'package:stream_feed_flutter_core/stream_feed_flutter_core.dart';
 
+/// {@template genericFlatFeedCore}
 /// [GenericFlatFeedCore] is a simplified class that allows fetching a list of
 /// enriched activities (flat) while exposing UI builders.
-///
-///
-/// ```dart
-/// class FlatActivityListPage extends StatelessWidget {
-///   @override
-///   Widget build(BuildContext context) {
-///     return Scaffold(
-///       body: GenericFlatFeedCore(
-///         onErrorWidget: Center(
-///             child: Text('An error has occurred'),
-///         ),
-///         onEmptyWidget: Center(
-///             child: Text('Nothing here...'),
-///         ),
-///         onProgressWidget: Center(
-///             child: CircularProgressIndicator(),
-///         ),
-///         feedBuilder: (context, activities, idx) {
-///           return YourActivityWidget(activity: activities[idx]);
-///         }
-///       ),
-///     );
-///   }
-/// }
-/// ```
-///
 /// Make sure to have a [GenericFeedProvider] ancestor in order to provide the
 /// information about the activities.
+/// Usually what you want is the convenient [FlatFeedCore] that already
+/// has the default parameters defined for you
+/// suitable to most use cases
+/// {@endtemplate}
 class GenericFlatFeedCore<A, Ob, T, Or> extends StatefulWidget {
   const GenericFlatFeedCore({
     Key? key,

packages/stream_feed_flutter_core/lib/src/typedefs.dart

@@ -22,7 +22,34 @@ typedef ReactionsBuilder = Widget Function(
  so this is hack until it is supported
 */
 
+/// {@template flatFeedCore}
 ///Convenient typedef for [GenericFlatFeedCore] with default parameters
+/// ## Usage
+///
+/// ```dart
+/// class FlatActivityListPage extends StatelessWidget {
+///   @override
+///   Widget build(BuildContext context) {
+///     return Scaffold(
+///       body: FlatFeedCore(
+///         onErrorWidget: Center(
+///             child: Text('An error has occurred'),
+///         ),
+///         onEmptyWidget: Center(
+///             child: Text('Nothing here...'),
+///         ),
+///         onProgressWidget: Center(
+///             child: CircularProgressIndicator(),
+///         ),
+///         feedBuilder: (context, activities, idx) {
+///           return YourActivityWidget(activity: activities[idx]);
+///         }
+///       ),
+///     );
+///   }
+/// }
+/// ```
+/// {@endtemplate}
 typedef FlatFeedCore = GenericFlatFeedCore<User, String, String, String>;
 
 ///Convenient typedef for [GenericReactionListCore] with default parameters