From 83f07971d5e68ddb6f14ee2d62c33d504ffab332 Mon Sep 17 00:00:00 2001 From: David Luecke Date: Wed, 4 Jan 2023 18:42:46 -0800 Subject: [PATCH] chore(docs): Website and guide updates (#2970) --- README.md | 2 +- docs/.vitepress/config.sidebar.ts | 2 +- docs/api/index.md | 80 ++++++++++---------- docs/components/HomeFeature1Content.vue | 2 +- docs/components/HomeFeature2Content.vue | 2 +- docs/components/HomeHero.vue | 2 +- docs/guides/basics/assets/feathers-chat.png | Bin 171982 -> 166377 bytes docs/guides/basics/generator.md | 24 +++++- docs/guides/basics/hooks.md | 31 ++++---- docs/guides/basics/schemas.md | 20 +++-- docs/guides/basics/services.md | 10 ++- docs/guides/basics/starting.md | 61 ++++++++++----- docs/guides/frontend/javascript.md | 41 +++++----- 13 files changed, 163 insertions(+), 114 deletions(-) diff --git a/README.md b/README.md index 6e44d48fe..9901cc882 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Download Status](https://img.shields.io/npm/dm/@feathersjs/feathers.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/feathers) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx) -Feathers is a lightweight web-framework for creating APIs and real-time applications with TypeScript or JavaScript. +Feathers is a full-stack web-framework for creating APIs and real-time applications with TypeScript or JavaScript. The FeathersJS Family of Birds diff --git a/docs/.vitepress/config.sidebar.ts b/docs/.vitepress/config.sidebar.ts index 0b2403bc2..160e93921 100644 --- a/docs/.vitepress/config.sidebar.ts +++ b/docs/.vitepress/config.sidebar.ts @@ -95,7 +95,7 @@ export default { { text: 'App Structure', collapsible: true, - collapsed: false, + collapsed: true, items: [ { text: '📂 config', diff --git a/docs/api/index.md b/docs/api/index.md index 38daf5a36..71a56bae7 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -4,62 +4,64 @@ outline: deep # API -This section describes all the individual modules and APIs of Feathers. There are three main sections of the API: - -- __Core:__ The Feathers core functionality that can be used on the server and the client -- __Server:__ Feathers server side modules used with Core when creating an API server in NodeJS -- __Client:__ Modules used on the client (NodeJS, browser or React Native) together with Core when connecting to a Feathers API server. - - Here is an overview how the individual sections of the API documentation fit together: - -![Feathers Architecture overview](./assets/architecture-overview.svg) +This section describes all the individual modules and APIs of Feathers. ## Core Feathers core functionality that works on the client and the server -- [Application](application) - The main Feathers application API -- [Services](services) - Service objects and their methods and Feathers specific functionality -- [Hooks](hooks) - Pluggable middleware for service methods -- [Events](events) - Events sent by Feathers service methods -- [Errors](errors) - A collection of error classes used throughout Feathers +- [Application](./application.md) - The main Feathers application API +- [Services](./services.md) - Service objects and their methods and Feathers specific functionality +- [Hooks](./hooks.md) - Pluggable middleware for service methods +- [Events](./events.md) - Events sent by Feathers service methods +- [Errors](./errors.md) - A collection of error classes used throughout Feathers ## Transports Expose a Feathers application as an API server -- [Koa](koa) - Feathers KoaJS framework bindings, REST API provider and error middleware. -- [Express](express) - Feathers Express framework bindings, REST API provider and error middleware. -- [Socket.io](socketio) - The Socket.io real-time transport provider -- [Configuration](configuration) - A node-config wrapper to initialize configuration of a server side application. -- [Channels](channels) - Decide what events to send to connected real-time clients - -## Client - -More details on how to use Feathers on the client - -- [Usage](client) - Feathers client usage in Node, React Native and the browser (also with Webpack and Browserify) -- [REST](client/rest) - Feathers client and direct REST API server usage -- [Socket.io](client/socketio) - Feathers client and direct Socket.io API server usage +- [Configuration](./configuration.md) - A node-config wrapper to initialize configuration of a server side application. +- [Koa](./koa.md) - Feathers KoaJS framework bindings, REST API provider and error middleware. +- [Express](./express.md) - Feathers Express framework bindings, REST API provider and error middleware. +- [Socket.io](./socketio.md) - The Socket.io real-time transport provider +- [Channels](./channels.md) - Channels are used to send real-time events to clients ## Authentication Feathers authentication mechanism -- [Service](authentication/service) - The main authentication service configuration -- [Strategies](authentication/strategy) - More about authentication strategies -- [Local](authentication/local) - Local email/password authentication -- [JWT](authentication/jwt) - JWT authentication -- [OAuth](authentication/oauth) - Using OAuth logins (Facebook, Twitter etc.) -- [Client](authentication/client) - A client for a Feathers authentication server +- [Service](./authentication/service.md) - The main authentication service configuration +- [Hook](./authentication/hook.md) - The hook used to authenticate service method calls +- [Strategies](./authentication/strategy.md) - More about authentication strategies +- [Local](./authentication/local.md) - Local email/password authentication +- [JWT](./authentication/jwt.md) - JWT authentication +- [OAuth](./authentication/oauth.md) - Using OAuth logins (Facebook, Twitter etc.) + +## Client + +More details on how to use Feathers on the client + +- [Usage](./client.md) - Feathers client usage in Node, React Native and the browser (also with Webpack and Browserify) +- [REST](./client/rest.md) - Feathers client and direct REST API server usage +- [Socket.io](./client/socketio.md) - Feathers client and direct Socket.io API server usage +- [Authentication](authentication/client) - A client for Feathers authentication + +## Schema + +Model definitions for validating and resolving data. + +- [TypeBox](./schema/typebox.md) - Integration for TypeBox, a JSON schema type builder +- [JSON schema](./schema/schema.md) - JSON schema integration +- [Validators](./schema/validators.md) - Schema validators and validation hooks +- [Resolvers](./schema/resolvers.md) - Dynamic data resolvers ## Databases Feathers common database adapter API and querying mechanism -- [Adapters](databases/adapters) - A list of supported database adapters -- [Common API](databases/common) - Database adapter common initialization and configuration API -- [Querying](databases/querying) - The common querying mechanism -- [Memory Adapter](databases/memory) - The adapter for in-memory data storage -- [MongoDB Adapter](databases/mongodb) - The adapter for MongoDB databases -- [Knex Adapter](databases/knex) - The adapter for SQL databases using KnexJS \ No newline at end of file +- [Adapters](./databases/adapters.md) - A list of supported database adapters +- [Common API](./databases/common.md) - Database adapter common initialization and configuration API +- [Querying](./databases/querying.md) - The common querying mechanism +- [MongoDB](./databases/querying.md) - The adapter for MongoDB databases +- [SQL](./databases/knex.md) - The adapter for SQL databases using KnexJS +- [Memory](./databases/memory.md) - The adapter for in-memory data storage diff --git a/docs/components/HomeFeature1Content.vue b/docs/components/HomeFeature1Content.vue index 4b193a401..8065068a8 100644 --- a/docs/components/HomeFeature1Content.vue +++ b/docs/components/HomeFeature1Content.vue @@ -1,7 +1,7 @@