diff options
author | Bryan Newbold <bnewbold@robocracy.org> | 2018-09-21 12:33:35 -0700 |
---|---|---|
committer | Bryan Newbold <bnewbold@robocracy.org> | 2018-09-21 12:34:06 -0700 |
commit | 1915c7b885641a34191efeee2cc8525a6ad27b9f (patch) | |
tree | c26b8a772d8e79689b0b7bf6498590d517717ece /guide/src/overview.md | |
parent | a1e5acf125decc0f2af28beca43e91b4085cc3d9 (diff) | |
download | fatcat-1915c7b885641a34191efeee2cc8525a6ad27b9f.tar.gz fatcat-1915c7b885641a34191efeee2cc8525a6ad27b9f.zip |
large progress on guide
Don't have enough time to complete and copy-edit this now though.
Diffstat (limited to 'guide/src/overview.md')
-rw-r--r-- | guide/src/overview.md | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/guide/src/overview.md b/guide/src/overview.md index ef631b87..58107429 100644 --- a/guide/src/overview.md +++ b/guide/src/overview.md @@ -1,10 +1,17 @@ -# Fatcat Overview -fatcat is an open bibliographic catalog of written works. The scope of works -is somewhat flexible, with a focus on published research outputs like journal -articles, pre-prints, and conference proceedings. Records are collaboratively -editable, versioned, available in bulk form, and include URL-agnostic -file-level metadata. +# High-Level Overview + +This section gives an introduction to: + +- the goals of the project, and now it relates to the rest of the Open Access + and archival ecosystem +- how catalog data is represented as entities and revisions with full edit + history, and how entities are refered to and cross-referenced with + identifiers +- how humans and bots propose changes to the catalog, and how these changes are + reviewed +- the major sources of bulk and continuously updated metadata that form the + foundation of the catalog +- a rough sketch of the software back-end, database, and libraries +- roadmap for near-future work -fatcat is currently used internally at the Internet Archive, but interested -folks are welcome to contribute to design and development. |