Documentation for Feature class

The Feature class seems like a key conceptual and organizational unit. It’s used throughout the code base, but there’s no documentation. Adding documentation for this particular item would be pretty high impact, IMO. It would make it much easier to use for beginners.

Here are some thoughts for an outline:

Feature Class Documentation

• Overview
  • Purpose
  • Client Feature vs Server Feature classes
• Server Feature
  • Arguments
    • schema
    • createResolversFunc
      • When is it invoked?
        • What should it return?
        • Using pubsub
          • explain the pubsub argument
      • createContextFunc
        • when is it invoked?
        • what should it return?
      • middleware
      • Hierarchical composition
        • explain new Feature(counter, post, user, graphqlTypes); in modules/index.js`
• Client Feature
  • Arguments
    • navItem
    • tabItems
    • route
    • reducer
    • features
  • Hierarchical composition
• Tutorial:
  • add a server feature
    • add a model using a migration
    • add graphql schema
    • add resolvers
  • add a client feature that uses the server feature

[aneilbaboo]

Great. I’ll submit a PR with the refactor and another PR on top of that with the documentation.

[verdverm]

I can put something in about Features with my upcoming auth docs. Here are some pointers in the meantime:

• Features are different in the client and server. You could theoretically have multiple types of features on either end. They can be fractal, that is, a feature can have sub features.
• Features are basically a predefined set of options that get recursively merged. Different params on the frontend and backend. You can change theses.
• Feature code is found at the root of the client/server module directories
  • Definitions are in connector.js in the server, connector.web.jsx in the client
  • Feature inclusion is in the index.js
  • Actual features import the connector.js file and add the params they want
• Common code uses Feature params to do things such as, create the context for the resolvers or build menus in the client.

In the auth-upgrades branch (https://github.com/sysgears/apollo-universal-starter-kit/tree/auth-upgrades)…

I have some examples of:

• conditional features based on settings (see the {client,server}/modules/index.js files)
• fractal features (see the {client,server}/modules/entities dirs)