From 90e671c2f647a5d34603cf3ccf83cfdc29dc0dcd Mon Sep 17 00:00:00 2001 From: redonkulus Date: Tue, 30 Jan 2024 13:25:34 -0800 Subject: [PATCH 1/3] docs: update doc page paths --- README.md | 4 ++-- docs/README.md | 1 - docs/community/libraries.md | 2 +- docs/community/reference-applications.md | 1 - examples/fluxible-router/README.md | 2 +- examples/todo/components/Html.js | 3 --- packages/fluxible-addons-react/README.md | 4 +--- packages/fluxible-plugin-fetchr/README.md | 2 +- .../fluxible-plugin-fetchr/docs/fluxible-plugin-fetchr.md | 2 +- packages/fluxible-router/docs/README.md | 1 - packages/fluxible/README.md | 4 +--- packages/fluxible/docs/api/Plugins.md | 2 +- packages/fluxible/lib/FluxibleContext.js | 2 +- 13 files changed, 10 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index afdd0ef2..6ec63806 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Fluxible ![Build Status](https://github.com/yahoo/fluxible/actions/workflows/node.js.yml/badge.svg) -This repository is the home of [Fluxible](http://fluxible.io/) and related libraries. +This repository is the home of Fluxible and related libraries. -For support, join our [gitter.im](https://gitter.im/yahoo/fluxible) channel. +For support, please use [GitHub Discussions](https://github.com/yahoo/fluxible/discussions). ## Development diff --git a/docs/README.md b/docs/README.md index 6a9d000d..bad41dea 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,6 @@ If you want to jump right into building your application, head over to our [Quic If you want to look at example applications, check out our examples: - - [Fluxible.io](https://github.com/yahoo/fluxible/blob/master/site) - Our very own documentation site written with Fluxible. - [Chat](https://github.com/yahoo/fluxible/blob/master/examples/chat) - Port of [Facebook's Flux chat example](https://github.com/facebook/flux/tree/master/examples/). - [Fluxible Router](https://github.com/yahoo/fluxible/blob/master/examples/fluxible-router) - Simple isomorphic routing in Flux flow. - [React Router](https://github.com/yahoo/fluxible/blob/master/examples/react-router) - Simple isomorphic routing with React router. diff --git a/docs/community/libraries.md b/docs/community/libraries.md index 6b7f99be..762b160f 100644 --- a/docs/community/libraries.md +++ b/docs/community/libraries.md @@ -25,7 +25,7 @@ Take a look at some of the libraries that our community has built. Edit this pag ## Actions - * [fluxible-action-utils](https://github.com/yahoo/fluxible-action-utils) - utility methods to aid in writing [actions](http://fluxible.io/api/fluxible-context.html#executeaction-action-payload-callback-) for [fluxible](http://fluxible.io) based applications. + * [fluxible-action-utils](https://github.com/yahoo/fluxible-action-utils) - utility methods to aid in writing [actions](https://github.com/yahoo/fluxible/blob/main/packages/fluxible/docs/api/Actions.md#action-context) for Fluxible based applications. * [fluxible-plugin-actions](https://github.com/gingur/fluxible-plugin-actions) - component context utility to get actions by key instead of path, useful for cross library components. ## Immutable.js diff --git a/docs/community/reference-applications.md b/docs/community/reference-applications.md index 0f3b3ac7..58bd434f 100644 --- a/docs/community/reference-applications.md +++ b/docs/community/reference-applications.md @@ -7,7 +7,6 @@ Want to add your application? Click edit above and open a PR! - [Contactor](https://github.com/localnerve/flux-react-example) is a data-driven Fluxible demo application. Uses [Fetchr](https://github.com/yahoo/fetchr), AMQP, and Github as a simple data service. Another possible useful source of inspiration for solving problems encountered while developing an isomorphic application. - [Dockunit.io](https://github.com/tlovett1/dockunit-platform/) is a containerized continuous integration testing service for running [Dockunit](https://github.com/tlovett1/dockunit) test suites hosted on Github. Built on Fluxible and Docker. It is 100% open source. - [Flux Examples](https://github.com/yahoo/fluxible/blob/master/examples) contains various Flux examples built with Fluxible. -- [Fluxible.io](https://github.com/yahoo/fluxible/blob/master/site) is this website! Showcases data fetching, routing, analytics, search and more. - [isomorphic500](https://github.com/gpbl/isomorphic500) is a Fluxible demo application showing photos from 500px. It uses the official Fluxible plugins, supports multiple language and includes a full-stack development environment. Useful as a source of inspiration to solve some common cases encountered while developing an isomorphic application. - [quad-blog](https://github.com/cesarandreu/quad-blog/) is a blog written with Fluxible. Another possible useful source of inspiration for solving problems encountered while developing an isomorphic application. - [SlideWiki Platform](https://github.com/slidewiki/slidewiki-platform) is an OpenCourseWare authoring platform. diff --git a/examples/fluxible-router/README.md b/examples/fluxible-router/README.md index 3fa08876..5d6d50f1 100644 --- a/examples/fluxible-router/README.md +++ b/examples/fluxible-router/README.md @@ -1,7 +1,7 @@ # routing with fluxible This shows routing on the client and the server with -[Fluxible](http://fluxible.io). Navigation uses history pushes on the +Fluxible. Navigation uses history pushes on the client but browser refresh will render the current page correctly on the server. diff --git a/examples/todo/components/Html.js b/examples/todo/components/Html.js index 924e7dd1..ad2bc260 100644 --- a/examples/todo/components/Html.js +++ b/examples/todo/components/Html.js @@ -34,9 +34,6 @@ const Component = (props) => ( TodoMVC React (Pete Hunt)

-

- Showing off Fluxible -

diff --git a/packages/fluxible-addons-react/README.md b/packages/fluxible-addons-react/README.md index 7d907ab5..c4f02ca7 100644 --- a/packages/fluxible-addons-react/README.md +++ b/packages/fluxible-addons-react/README.md @@ -8,9 +8,7 @@ $ npm install --save fluxible-addons-react ``` -Join the #fluxible channel of the [Reactiflux](http://reactiflux.com) Discord community. - -[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/yahoo/fluxible) +For support, please use [GitHub Discussions](https://github.com/yahoo/fluxible/discussions). ## Docs diff --git a/packages/fluxible-plugin-fetchr/README.md b/packages/fluxible-plugin-fetchr/README.md index 4df038dc..2ba1f57f 100644 --- a/packages/fluxible-plugin-fetchr/README.md +++ b/packages/fluxible-plugin-fetchr/README.md @@ -98,7 +98,7 @@ By Default, fetchr appends all context values to the xhr url as query params. `c To collect fetcher service's success/failure/latency stats, you can configure `statsCollector` for `FetchrPlugin`. The `statsCollector` function will be invoked with two arguments: `actionContext` and `stats`: -* **actionContext:** This is the [action context](http://fluxible.io/api/actions.html#action-context) object provided by [Fluxible](http://fluxible.io/). +* **actionContext:** This is the [action context](https://github.com/yahoo/fluxible/blob/main/packages/fluxible/docs/api/Actions.md#action-context) object provided by [Fluxible](http://fluxible.io/). * **stats:** This object contains all stats data for each service CRUD request. [See Fetchr docs for more info about provided stats data fields.](https://github.com/yahoo/fetchr/blob/master/README.md#stats-monitoring--analysis) Example for how to configure `statsCollector`: diff --git a/packages/fluxible-plugin-fetchr/docs/fluxible-plugin-fetchr.md b/packages/fluxible-plugin-fetchr/docs/fluxible-plugin-fetchr.md index dda13ec4..6a06e04b 100644 --- a/packages/fluxible-plugin-fetchr/docs/fluxible-plugin-fetchr.md +++ b/packages/fluxible-plugin-fetchr/docs/fluxible-plugin-fetchr.md @@ -9,7 +9,7 @@ Creates a new `fetchr` plugin instance with the following parameters: * `options.xhrPath='/api'` (optional): Stores your xhr path prefix used by client side requests. * `options.xhrTimeout=3000` (optional): Timeout in milliseconds for all XHR requests (can be overridden per request). * `options.statsCollector` (optional): This function will be invoked for each fetcher request with two arguments: - * **actionContext:** This is the [action context](http://fluxible.io/api/actions.html#action-context) object provided by [Fluxible](http://fluxible.io/). + * **actionContext:** This is the [action context](https://github.com/yahoo/fluxible/blob/main/packages/fluxible/docs/api/Actions.md#action-context) object provided by [Fluxible](http://fluxible.io/). * **stats:** This object contains all stats data for each service CRUD request. [See Fetchr docs for more info about provided stats data fields.](https://github.com/yahoo/fetchr/blob/master/README.md#stats-monitoring--analysis) ## Instance Methods diff --git a/packages/fluxible-router/docs/README.md b/packages/fluxible-router/docs/README.md index 04a1db90..67d2d8ed 100644 --- a/packages/fluxible-router/docs/README.md +++ b/packages/fluxible-router/docs/README.md @@ -4,6 +4,5 @@ If you want to look at example applications, check out our examples: - - [Fluxible.io](https://github.com/yahoo/fluxible/blob/master/site) - Our very own documentation site written with Fluxible and Fluxible Router. - [Chat](https://github.com/yahoo/fluxible/tree/master/examples/chat) - Port of [Facebook's Flux chat example](https://github.com/facebook/flux/tree/master/examples/). - [Fluxible Router](https://github.com/yahoo/fluxible/tree/master/examples/fluxible-router) - Simple isomorphic routing in Flux flow. diff --git a/packages/fluxible/README.md b/packages/fluxible/README.md index fcbedf69..6320027c 100644 --- a/packages/fluxible/README.md +++ b/packages/fluxible/README.md @@ -14,9 +14,7 @@ Pluggable, singleton-free container for isomorphic [Flux](https://github.com/fac $ npm install --save fluxible ``` -Join the #fluxible channel of the [Reactiflux](http://reactiflux.com) Discord community. - -[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/yahoo/fluxible) +For support, please use [GitHub Discussions](https://github.com/yahoo/fluxible/discussions). ## Docs diff --git a/packages/fluxible/docs/api/Plugins.md b/packages/fluxible/docs/api/Plugins.md index 1e64f32e..fe47d797 100644 --- a/packages/fluxible/docs/api/Plugins.md +++ b/packages/fluxible/docs/api/Plugins.md @@ -92,7 +92,7 @@ context.getComponentContext().getFoo(); // returns 'bar' ### componentContext -To leverage the new context value in componentContext, `provideContext` has an option for [passing custom contextTypes](http://fluxible.io/addons/provideContext.html#plugins-and-custom-component-context) which will ensure that it is made available to all children. +To leverage the new context value in componentContext, `provideContext` has an option for [passing custom contextTypes](https://github.com/yahoo/fluxible/blob/main/packages/fluxible/docs/api/Components.md#providing-the-context) which will ensure that it is made available to all children. ```js // create the React component as usual diff --git a/packages/fluxible/lib/FluxibleContext.js b/packages/fluxible/lib/FluxibleContext.js index b5a467c9..892612fc 100644 --- a/packages/fluxible/lib/FluxibleContext.js +++ b/packages/fluxible/lib/FluxibleContext.js @@ -295,7 +295,7 @@ FluxContext.prototype.getComponentContext = function getComponentContext() { console.warn( 'When calling executeAction from a component, ' + "a callback isn't allowed. See our docs for more info: " + - 'http://fluxible.io/api/components.html#component-context', + 'https://github.com/yahoo/fluxible/blob/main/packages/fluxible/docs/api/Components.md#component-context', ); } } From 505116fec4c74d5b889addcd9257503ff92600cb Mon Sep 17 00:00:00 2001 From: redonkulus Date: Tue, 30 Jan 2024 14:08:06 -0800 Subject: [PATCH 2/3] docs: add links to readmes --- README.md | 4 ++ docs/home.md | 4 +- .../docs/fluxible-plugin-fetchr.md | 2 +- packages/fluxible/README.md | 42 ++++++++----------- packages/fluxible/docs/api/Fluxible.md | 2 + packages/fluxible/docs/api/Plugins.md | 1 + packages/fluxible/docs/api/README.md | 38 +++++++---------- 7 files changed, 44 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 6ec63806..81a31038 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ This repository is the home of Fluxible and related libraries. For support, please use [GitHub Discussions](https://github.com/yahoo/fluxible/discussions). +## Documentation + +Please check out the Fluxible package [README](https://github.com/yahoo/fluxible/blob/main/packages/fluxible/README.md) for documentation. + ## Development All code is developed against the latest Node LTS version. This repository leverages [npm workspaces][] for package management. diff --git a/docs/home.md b/docs/home.md index 19f6a35c..5ad84c47 100644 --- a/docs/home.md +++ b/docs/home.md @@ -20,6 +20,6 @@ Helper utilities for integrating your Fluxible app into React [components](../pa Want to add your own interfaces to the Flux flow? [Plugins](../packages/fluxible/docs/api/Plugins.md) allow you to add methods to any of the contexts. -## Updated for React 17 +## Updated for Latest React -Updated to follow React 17's changes and the deprecations coming in the next version of React. +Updated to follow React's changes and the deprecations coming in the next version of React. diff --git a/packages/fluxible-plugin-fetchr/docs/fluxible-plugin-fetchr.md b/packages/fluxible-plugin-fetchr/docs/fluxible-plugin-fetchr.md index 6a06e04b..e1b64abe 100644 --- a/packages/fluxible-plugin-fetchr/docs/fluxible-plugin-fetchr.md +++ b/packages/fluxible-plugin-fetchr/docs/fluxible-plugin-fetchr.md @@ -18,7 +18,7 @@ Creates a new `fetchr` plugin instance with the following parameters: getter for the `xhrPath` option passed into the constructor. -``` +```js var pluginInstance = fetchrPlugin({ xhrPath: '/api' }); diff --git a/packages/fluxible/README.md b/packages/fluxible/README.md index 6320027c..a7758ee0 100644 --- a/packages/fluxible/README.md +++ b/packages/fluxible/README.md @@ -1,42 +1,36 @@ -# Fluxible - -[![NPM version](https://badge.fury.io/js/fluxible.svg)](http://badge.fury.io/js/fluxible) - +# Fluxible [![NPM version](https://badge.fury.io/js/fluxible.svg)](http://badge.fury.io/js/fluxible) Pluggable, singleton-free container for isomorphic [Flux](https://github.com/facebook/flux) applications. ```bash -$ npm install --save fluxible +npm install --save fluxible ``` For support, please use [GitHub Discussions](https://github.com/yahoo/fluxible/discussions). ## Docs - * [Quick Start](https://github.com/yahoo/fluxible/blob/master/docs/quick-start.md) - * [API](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/README.md) +* [Quick Start](https://github.com/yahoo/fluxible/blob/master/docs/quick-start.md) +* [API](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/README.md) +* [Data Fetching](https://github.com/yahoo/fluxible/blob/main/packages/fluxible-plugin-fetchr/README.md) +* [Routing](https://github.com/yahoo/fluxible/blob/main/packages/fluxible-router/README.md) ## Features - * Singleton-free for server rendering - * [Store](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Stores.md) dehydration for client bootstrapping - * Stateless async [actions](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Actions.md) - * Higher order [components](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Components.md) for easy integration - * Enforcement of Flux flow - restricted access to the [Flux interface](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/FluxibleContext.md) from within components - * [Pluggable](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Plugins.md) - add your own interfaces to the Flux context - * Updated for React 15 +* Singleton-free for server rendering +* [Store](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Stores.md) dehydration for client bootstrapping +* Stateless async [actions](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Actions.md) +* Higher order [components](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Components.md) for easy integration +* Enforcement of Flux flow - restricted access to the [Flux interface](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/FluxibleContext.md) from within components +* [Pluggable](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Plugins.md) - add your own interfaces to the Flux context +* Updated for React 15 ## Extras - * [Yeoman generator](https://github.com/yahoo/fluxible/blob/master/packages/generator-fluxible) - * [Example Applications](https://github.com/yahoo/fluxible/blob/master/examples) - * [Fluxible Routing](https://github.com/yahoo/fluxible/blob/master/packages/fluxible-router) - * [Isomorphic Data Services](https://github.com/yahoo/fluxible/blob/master/packages/fluxible-plugin-fetchr) +* [Yeoman generator](https://github.com/yahoo/fluxible/blob/master/packages/generator-fluxible) +* [Example Applications](https://github.com/yahoo/fluxible/blob/master/examples) +* [Fluxible Routing](https://github.com/yahoo/fluxible/blob/master/packages/fluxible-router) +* [Isomorphic Data Services](https://github.com/yahoo/fluxible/blob/master/packages/fluxible-plugin-fetchr) ## Usage @@ -102,7 +96,7 @@ context.executeAction(action, 'bar', (err) => { ## Browser Compatibility Fluxible is written with ES2015 in mind and should be used along with polyfills -for features like [`Promise`][Promise] and [`Object.assign`][objectAssign] +for features like [`Promise`][Promise] and [`Object.assign`][objectAssign] in order to support all browsers. We recommend using [Babel][babel] along with its [polyfill][polyfill]. diff --git a/packages/fluxible/docs/api/Fluxible.md b/packages/fluxible/docs/api/Fluxible.md index 6d43c348..e828ca37 100644 --- a/packages/fluxible/docs/api/Fluxible.md +++ b/packages/fluxible/docs/api/Fluxible.md @@ -6,6 +6,7 @@ Instantiated once for your application, this holds settings and interfaces that ```js import Fluxible from 'fluxible'; + const fluxibleApp = new Fluxible({ component: require('./components/App.jsx') }); @@ -15,6 +16,7 @@ For each request: ```js const context = fluxibleApp.createContext(); + context.executeAction(action, payload, function () { const element = React.createElement(context.getComponent(), { context: context.getComponentContext() diff --git a/packages/fluxible/docs/api/Plugins.md b/packages/fluxible/docs/api/Plugins.md index fe47d797..a2013672 100644 --- a/packages/fluxible/docs/api/Plugins.md +++ b/packages/fluxible/docs/api/Plugins.md @@ -8,6 +8,7 @@ Here, we'll give components access to the `getFoo()` function: ```js import Fluxible from 'fluxible'; + let app = new Fluxible(); app.plug({ diff --git a/packages/fluxible/docs/api/README.md b/packages/fluxible/docs/api/README.md index b5b69e6b..5380ac37 100644 --- a/packages/fluxible/docs/api/README.md +++ b/packages/fluxible/docs/api/README.md @@ -1,11 +1,6 @@ # API Documentation -`var Fluxible = require('fluxible')` exports the following: - - * [`Fluxible`](Fluxible.md) - - -or if you're using ES6: +[`Fluxible`](Fluxible.md) exports the following: ```js import Fluxible from 'fluxible'; @@ -17,38 +12,37 @@ Occasionally you may find that you need to use [plugins](Plugins.md) to extend F ## Addons -`var FluxibleAddons = require('fluxible/addons')` also provides helper utilities for creating stores: +FluxibleAddons provides helper utilities for creating stores: - * [`FluxibleAddons.BaseStore`](addons/BaseStore.md) - * [`FluxibleAddons.createStore`](addons/createStore.md) - -or if you're using ES6: +* [`FluxibleAddons.BaseStore`](addons/BaseStore.md) +* [`FluxibleAddons.createStore`](addons/createStore.md) ```js -import {BaseStore, createStore} from 'fluxible/addons'; +import { BaseStore, createStore } from 'fluxible/addons'; ``` These libraries are not bundled with the main Fluxible export because stores are decoupled from Fluxible. ## React Addons -`npm i --save fluxible-addons-react` +Install the package: -`var ReactAddons = require('fluxible-addons-react');` provides helpers for -using Fluxible with React. +```bash +npm i --save fluxible-addons-react +``` - * [`FluxibleAddons.connectToStores`](../../../../packages/fluxible-addons-react/docs/api/connectToStores.md) - * [`FluxibleAddons.FluxibleComponent`](../../../../packages/fluxible-addons-react/docs/api/FluxibleComponent.md) - * [`FluxibleAddons.FluxibleMixin`](../../../../packages/fluxible-addons-react/docs/api/FluxibleMixin.md) - * [`FluxibleAddons.provideContext`](../../../../packages/fluxible-addons-react/docs/api/provideContext.md) +`fluxible-addons-react` provides helpers for using Fluxible with React. -or if you're using ES6: +* [`FluxibleAddons.connectToStores`](../../../../packages/fluxible-addons-react/docs/api/connectToStores.md) +* [`FluxibleAddons.FluxibleComponent`](../../../../packages/fluxible-addons-react/docs/api/FluxibleComponent.md) +* [`FluxibleAddons.FluxibleMixin`](../../../../packages/fluxible-addons-react/docs/api/FluxibleMixin.md) +* [`FluxibleAddons.provideContext`](../../../../packages/fluxible-addons-react/docs/api/provideContext.md) ```js -import {connectToStores, FluxibleComponent, FluxibleMixin, provideContext} from 'fluxible-addons-react'; +import { connectToStores, FluxibleComponent, FluxibleMixin, provideContext } from 'fluxible-addons-react'; ``` -These libraries are not bundled with Fluxible to allow for Fluxible usage with +These libraries are not bundled with Fluxible to allow for Fluxible usage with other view libraries such as React Native. ## Utils From 128ab19a7b404bcc21829b1a53cc8821db4b88a4 Mon Sep 17 00:00:00 2001 From: redonkulus Date: Tue, 30 Jan 2024 14:23:19 -0800 Subject: [PATCH 3/3] docs: updates --- packages/fluxible/README.md | 25 ++++++++++++++++--------- packages/fluxible/docs/api/README.md | 22 +++++++++++++++------- 2 files changed, 31 insertions(+), 16 deletions(-) diff --git a/packages/fluxible/README.md b/packages/fluxible/README.md index a7758ee0..5ff5d9ff 100644 --- a/packages/fluxible/README.md +++ b/packages/fluxible/README.md @@ -8,22 +8,22 @@ npm install --save fluxible For support, please use [GitHub Discussions](https://github.com/yahoo/fluxible/discussions). -## Docs - -* [Quick Start](https://github.com/yahoo/fluxible/blob/master/docs/quick-start.md) -* [API](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/README.md) -* [Data Fetching](https://github.com/yahoo/fluxible/blob/main/packages/fluxible-plugin-fetchr/README.md) -* [Routing](https://github.com/yahoo/fluxible/blob/main/packages/fluxible-router/README.md) - ## Features * Singleton-free for server rendering * [Store](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Stores.md) dehydration for client bootstrapping * Stateless async [actions](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Actions.md) -* Higher order [components](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Components.md) for easy integration +* Higher-order [components](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Components.md) for easy integration * Enforcement of Flux flow - restricted access to the [Flux interface](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/FluxibleContext.md) from within components * [Pluggable](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/Plugins.md) - add your own interfaces to the Flux context -* Updated for React 15 + +## Docs + +* [Quick Start](https://github.com/yahoo/fluxible/blob/master/docs/quick-start.md) +* [API](https://github.com/yahoo/fluxible/blob/master/packages/fluxible/docs/api/README.md) +* [Data Fetching](https://github.com/yahoo/fluxible/blob/main/packages/fluxible-plugin-fetchr/README.md) +* [Routing](https://github.com/yahoo/fluxible/blob/main/packages/fluxible-router/README.md) + ## Extras @@ -32,6 +32,13 @@ For support, please use [GitHub Discussions](https://github.com/yahoo/fluxible/d * [Fluxible Routing](https://github.com/yahoo/fluxible/blob/master/packages/fluxible-router) * [Isomorphic Data Services](https://github.com/yahoo/fluxible/blob/master/packages/fluxible-plugin-fetchr) +## Community + +* [Article](https://github.com/yahoo/fluxible/blob/main/docs/community/articles.md) +* [Libraries](https://github.com/yahoo/fluxible/blob/main/docs/community/libraries.md) +* [Presentations](https://github.com/yahoo/fluxible/blob/main/docs/community/presentations.md) +* [References Apps](https://github.com/yahoo/fluxible/blob/main/docs/community/reference-applications.md) + ## Usage ```js diff --git a/packages/fluxible/docs/api/README.md b/packages/fluxible/docs/api/README.md index 5380ac37..97324c19 100644 --- a/packages/fluxible/docs/api/README.md +++ b/packages/fluxible/docs/api/README.md @@ -14,8 +14,8 @@ Occasionally you may find that you need to use [plugins](Plugins.md) to extend F FluxibleAddons provides helper utilities for creating stores: -* [`FluxibleAddons.BaseStore`](addons/BaseStore.md) -* [`FluxibleAddons.createStore`](addons/createStore.md) +* [`BaseStore`](addons/BaseStore.md) +* [`createStore`](addons/createStore.md) ```js import { BaseStore, createStore } from 'fluxible/addons'; @@ -33,10 +33,14 @@ npm i --save fluxible-addons-react `fluxible-addons-react` provides helpers for using Fluxible with React. -* [`FluxibleAddons.connectToStores`](../../../../packages/fluxible-addons-react/docs/api/connectToStores.md) -* [`FluxibleAddons.FluxibleComponent`](../../../../packages/fluxible-addons-react/docs/api/FluxibleComponent.md) -* [`FluxibleAddons.FluxibleMixin`](../../../../packages/fluxible-addons-react/docs/api/FluxibleMixin.md) -* [`FluxibleAddons.provideContext`](../../../../packages/fluxible-addons-react/docs/api/provideContext.md) +* [`batchedUpdatePlugin`](../../../../packages/fluxible-addons-react/docs/api/batchedUpdatePlugin.md) +* [`connectToStores`](../../../../packages/fluxible-addons-react/docs/api/connectToStores.md) +* [`createElementWithContext`](../../../../packages/fluxible-addons-react/docs/api/createElementWithContext.md) +* [`FluxibleComponent`](../../../../packages/fluxible-addons-react/docs/api/FluxibleComponent.md) +* [`FluxibleMixin`](../../../../packages/fluxible-addons-react/docs/api/FluxibleMixin.md) +* [`provideContext`](../../../../packages/fluxible-addons-react/docs/api/provideContext.md) +* [`useFluxible`](../../../../packages/fluxible-addons-react/docs/api/useFluxible.md) +* [`withFluxible`](../../../../packages/fluxible-addons-react/docs/api/withFluxible.md) ```js import { connectToStores, FluxibleComponent, FluxibleMixin, provideContext } from 'fluxible-addons-react'; @@ -45,7 +49,11 @@ import { connectToStores, FluxibleComponent, FluxibleMixin, provideContext } fro These libraries are not bundled with Fluxible to allow for Fluxible usage with other view libraries such as React Native. -## Utils +## Debugging + +* [fluxible-plugin-devtools](https://github.com/yahoo/fluxible/blob/main/packages/fluxible-plugin-devtools/docs/fluxible-plugin-devtools.md) + +## Testing Fluxible also provides the following utilities for testing your components: