gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added a small introduction to architecture.md

Browse Source
This commit is contained in:
Mathias Biilmann Christensen 2016-06-18 12:28:37 -07:00
parent 3f11a93056
commit 2408425b2f
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
architecture.md
View File

@ -2,6 +2,16 @@
Netlify CMS is a React Application, using Redux for state management with immutable data structures (immutable.js). Netlify CMS is a React Application, using Redux for state management with immutable data structures (immutable.js).
The core abstractions for content editing are `collections`, `entries` and `widgets`.
Each `collection` represents a collection of entries. This can either be a collection of similar entries with the same structure, or a set of entries that each of their own structure.
The structure of an entry is defined as a series of fields, each with a `name`, a `label` and a `widget` .
The `widget` determines the UI widget that the content editor will use when editing this field of an entry, as well as how the content of the field is presented in the editing preview.
Entries are loaded and persisted through a `backend` that will typically represent a `git` repository.
## State shape / reducers ## State shape / reducers
**Auth:** Keeps track of the logged state and the current user. **Auth:** Keeps track of the logged state and the current user.