docs: add links to readmes

yahoo · Jan 30, 2024 · 505116f · 505116f
1 parent 90e671c
commit 505116f
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 49 deletions.
diff --git 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
@@ -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
@@ -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
@@ -1,42 +1,36 @@
-# Fluxible
-
-[![NPM version](https://badge.fury.io/js/fluxible.svg)](http://badge.fury.io/js/fluxible)
-<!--
-[![Build Status](https://img.shields.io/travis/yahoo/fluxible.svg)](https://travis-ci.org/yahoo/fluxible)
-[![Coverage Status](https://img.shields.io/coveralls/yahoo/fluxible.svg)](https://coveralls.io/r/yahoo/fluxible?branch=master)
-[![Dependency Status](https://img.shields.io/david/yahoo/fluxible.svg)](https://david-dm.org/yahoo/fluxible)
-[![devDependency Status](https://img.shields.io/david/dev/yahoo/fluxible.svg)](https://david-dm.org/yahoo/fluxible#info=devDependencies)
--->
+# 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
@@ -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
@@ -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
@@ -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