Update screenshots, docs & readme

README.md

@@ -16,8 +16,7 @@
 
 Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, _less paper_.
 
-Paperless-ngx forked from [paperless-ng](https://github.com/jonaswinkler/paperless-ng) to continue the great work and distribute responsibility of supporting and advancing the project among a team of people. [Consider joining us!](#community-support) Discussion of this transition can be found in issues
+Paperless-ngx is the official successor to the original 'Paperless' & 'Paperless-ng' projects and is designed distribute responsibility of supporting and advancing the project among a team of people. [Consider joining us!](#community-support).
-[#1599](https://github.com/jonaswinkler/paperless-ng/issues/1599) and [#1632](https://github.com/jonaswinkler/paperless-ng/issues/1632).
 
 A demo is available at [demo.paperless-ngx.com](https://demo.paperless-ngx.com) using login `demo` / `demo`. _Note: demo content is reset frequently and confidential information should not be uploaded._
 
@@ -36,28 +35,7 @@ A demo is available at [demo.paperless-ngx.com](https://demo.paperless-ngx.com)
 ![Dashboard](https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docs/assets/screenshots/documents-smallcards.png#gh-light-mode-only)
 ![Dashboard](https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docs/assets/screenshots/documents-smallcards-dark.png#gh-dark-mode-only)
 
-- Organize and index your scanned documents with tags, correspondents, types, and more.
+A full list of [features](https://docs.paperless-ngx.com/#features) and [screenshots](https://docs.paperless-ngx.com/#screenshots) are available in the [documentation](https://docs.paperless-ngx.com/).
-- Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents.
-- Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents).
-  - Office document support is optional and provided by Apache Tika (see [configuration](https://docs.paperless-ngx.com/configuration/#tika))
-- Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely.
-- Single page application front end.
-  - Includes a dashboard that shows basic statistics and has document upload.
-  - Filtering by tags, correspondents, types, and more.
-  - Customizable views can be saved and displayed on the dashboard.
-- Full text search helps you find what you need.
-  - Auto completion suggests relevant words from your documents.
-  - Results are sorted by relevance to your search query.
-  - Highlighting shows you which parts of the document matched the query.
-  - Searching for similar documents ("More like this")
-- Email processing: Paperless adds documents from your email accounts.
-  - Configure multiple accounts and filters for each account.
-  - When adding documents from mail, paperless can move these mail to a new folder, mark them as read, flag them as important or delete them.
-- Machine learning powered document matching.
-  - Paperless-ngx learns from your documents and will be able to automatically assign tags, correspondents and types to documents once you've stored a few documents in paperless.
-- Optimized for multi core systems: Paperless-ngx consumes multiple documents in parallel.
-- The integrated sanity checker makes sure that your document archive is in good health.
-- [More screenshots are available in the documentation](https://docs.paperless-ngx.com/#screenshots).
 
 # Getting started
 

docs/configuration.md

@@ -708,7 +708,7 @@ but could result in missing text content.
 additional arguments you wish to pass to OCRmyPDF. Since Paperless
 uses the API of OCRmyPDF, you have to specify these in a format that
 can be passed to the API. See [the API reference of
-OCRmyPDF](https://ocrmypdf.readthedocs.io/en/latestapi.md.html#reference)
+OCRmyPDF](https://ocrmypdf.readthedocs.io/en/latest/api.html#reference)
 for valid parameters. All command line options are supported, but
 they use underscores instead of dashes.
 

docs/index.md

@@ -15,62 +15,52 @@ physical documents into a searchable online archive so you can keep, well, _less
 </div>
 <div class="clear"></div>
 
-## Why This Exists
+## Features
 
-Paper is a nightmare. Environmental issues aside, there's no excuse for
+- **Organize and index** your scanned documents with tags, correspondents, types, and more.
-it in the 21st century. It takes up space, collects dust, doesn't
+- Performs **OCR** on your documents, adding selectable text to image-only documents.
-support any form of a search feature, indexing is tedious, it's heavy
+- Uses machine-learning to automatically add tags, correspondents and document types to your documents.
-and prone to damage & loss.
+- Supports PDF documents, images, plain text files, Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents)[^1] and more.
+- Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely with different configurations assigned to different documents.
+- **Beautiful, modern web application** that features:
+  - Customizable dashboard with statistics.
+    - Filtering by tags, correspondents, types, and more.
+    - Bulk editing of tags, correspondents, types and more.
+    - Drag-and-drop uploading of documents throughout the app.
+    - Customizable views can be saved and displayed on the dashboard and / or sidebar.
+    - Support for custom fields of various data types.
+    - Shareable public links with optional expiration.
+  - **Full text search** helps you find what you need.
+  - Auto completion suggests relevant words from your documents.
+    - Results are sorted by relevance to your search query.
+    - Highlighting shows you which parts of the document matched the query.
+    - Searching for similar documents ("More like this")
+  - **Email processing**[^1]: import documents from your email accounts
+  - Configure multiple accounts and rules for each account.
+    - After processing, paperless can perform actions on the messages such as marking as read, deleting and more.
+  - A built-in robust **multi-user permissions** system that supports 'global' permissions as well as per document or object.
+- A powerful templating system that gives you more control over the consumption pipeline.
+- **Optimized** for multi core systems: Paperless-ngx consumes multiple documents in parallel.
+- The integrated sanity checker makes sure that your document archive is in good health.
 
-This software is designed to make "going paperless" easier. No more worrying
+[^1]: Office document and email consumption support is optional and provided by Apache Tika (see [configuration](https://docs.paperless-ngx.com/configuration/#tika))
-about finding stuff again, feed documents right from the post box into
-the scanner and then shred them. Perhaps you might find it useful too.
 
 ## Paperless, a history
 
-Paperless is a simple Django application running in two parts: a
+Paperless-ngx is the official successor to the original [Paperless](https://github.com/the-paperless-project/paperless) & [Paperless-ng](https://github.com/jonaswinkler/paperless-ng) projects and is designed to continue the great work and distribute responsibility of supporting and advancing the project among a team of people. [Consider joining us!](https://github.com/paperless-ngx/paperless-ngx#community-support)
-_Consumer_ (the thing that does the indexing) and the _Web server_ (the
-part that lets you search & download already-indexed documents). If you
-want to learn more about its functions keep on reading after the
-installation section.
 
-Paperless-ngx is a document management system that transforms your
+Further discussion of the transition between these projects can be found at
-physical documents into a searchable online archive so you can keep,
+[ng#1599](https://github.com/jonaswinkler/paperless-ng/issues/1599) and [ng#1632](https://github.com/jonaswinkler/paperless-ng/issues/1632).
-well, _less paper_.
-
-Paperless-ngx forked from paperless-ng to continue the great work and
-distribute responsibility of supporting and advancing the project among
-a team of people.
-
-NG stands for both Angular (the framework used for the Frontend) and
-next-gen. Publishing this project under a different name also avoids
-confusion between paperless and paperless-ngx.
-
-If you want to learn about what's different in paperless-ngx from
-Paperless, check out these resources in the documentation:
-
-- [Some screenshots](#screenshots) of the new UI are available.
-- Read [this section](advanced_usage.md#automatic-matching) if you want to learn about how paperless automates all
-  tagging using machine learning.
-- Paperless now comes with a [proper email consumer](usage.md#usage-email) that's fully tested and production ready.
-- Paperless creates searchable PDF/A documents from whatever you put into the consumption directory. This means
-  that you can select text in image-only documents coming from your scanner.
-- See [this note](administration.md#encryption) about GnuPG encryption in paperless-ngx.
-- Paperless is now integrated with a
-  [task processing queue](setup.md#task_processor) that tells you at a glance when and why something is not working.
-- The [changelog](changelog.md) contains a detailed list of all changes in paperless-ngx.
 
 ## Screenshots
 
-This is what Paperless-ngx looks like.
+Paperless-ngx aims to be as nice to use as it is useful. Check out some screenshots below.
 
-The dashboard shows customizable views on your document and allows
+The dashboard shows saved views which can be sorted. Documents can be uploaded with the button or dropped anywhere in the application:
-document uploads:
 
 [![image](assets/screenshots/dashboard.png)](assets/screenshots/dashboard.png)
 
-The document list provides three different styles to scroll through your
+The document list provides three different styles to browser your documents:
-documents:
 
 [![image](assets/screenshots/documents-table.png)](assets/screenshots/documents-table.png)
 
@@ -78,15 +68,19 @@ documents:
 
 [![image](assets/screenshots/documents-largecards.png)](assets/screenshots/documents-largecards.png)
 
+Use the 'slim' sidebar to focus on just your docs:
+
+[![image](assets/screenshots/documents-smallcards-slimsidebar.png)](assets/screenshots/documents-smallcards-slimsidebar.png)
+
 Paperless-ngx also supports dark mode:
 
 [![image](assets/screenshots/documents-smallcards-dark.png)](assets/screenshots/documents-smallcards-dark.png)
 
-Extensive filtering mechanisms:
+Quickly find documents with extensive filtering mechanisms:
 
 [![image](assets/screenshots/documents-filter.png)](assets/screenshots/documents-filter.png)
 
-Bulk editing of document tags, correspondents, etc.:
+Bulk edit document tags, correspondents, etc. as well as permissions:
 
 [![image](assets/screenshots/bulk-edit.png)](assets/screenshots/bulk-edit.png)
 
@@ -94,24 +88,36 @@ Side-by-side editing of documents:
 
 [![image](assets/screenshots/editing.png)](assets/screenshots/editing.png)
 
+Support for custom fields:
+
+[![image](assets/screenshots/custom_field1.png){: style="width:50%; margin-left: 25%"}](assets/screenshots/custom_field1.png)
+[![image](assets/screenshots/custom_field2.png)](assets/screenshots/custom_field2.png)
+
+A robust permissions system with support for 'global' and document / object permissions:
+
+[![image](assets/screenshots/permissions_global.png){: style="width:50%; margin-left: 25%"}](assets/screenshots/permissions_global.png)
+[![image](assets/screenshots/permissions_document.png)](assets/screenshots/permissions_document.png)
+
 Tag editing. This looks about the same for correspondents and document
 types.
 
-[![image](assets/screenshots/new-tag.png)](assets/screenshots/new-tag.png)
+[![image](assets/screenshots/new-tag.png){: style="width:50%; margin-left: 25%"}](assets/screenshots/new-tag.png)
 
 Searching provides auto complete and highlights the results.
 
-[![image](assets/screenshots/search-preview.png)](assets/screenshots/search-preview.png)
+[![image](assets/screenshots/search-preview.png){: style="width:50%; margin-left: 25%"}](assets/screenshots/search-preview.png)
 
 [![image](assets/screenshots/search-results.png)](assets/screenshots/search-results.png)
 
 Fancy mail filters!
 
-[![image](assets/screenshots/mail-rules-edited.png)](assets/screenshots/mail-rules-edited.png)
+[![image](assets/screenshots/mail-rules-edited.png){: style="width:80%; margin-left: 10%"}](assets/screenshots/mail-rules-edited.png)
 
 Mobile devices are supported.
 
-[![image](assets/screenshots/mobile.png)](assets/screenshots/mobile.png)
+[![image](assets/screenshots/mobile1.png){: style="width:33%"}](assets/screenshots/mobile1.png)
+[![image](assets/screenshots/mobile2.png){: style="width:33%"}](assets/screenshots/mobile2.png)
+[![image](assets/screenshots/mobile3.png){: style="width:33%"}](assets/screenshots/mobile3.png)
 
 ## Support
 
@@ -131,7 +137,7 @@ People interested in continuing the work on paperless-ngx are encouraged to reac
 
 ### Translation
 
-Paperless-ngx is available in many languages that are coordinated on [Crowdin](https://crwd.in/paperless-ngx). If you want to help out by translating paperless-ngx into your language, please head over to https://crwd.in/paperless-ngx, and thank you!
+Paperless-ngx is available in many languages that are coordinated on [Crowdin](https://crwd.in/paperless-ngx). If you want to help out by translating paperless-ngx into your language, please head over to the [Paperless-ngx project at Crowdin](https://crwd.in/paperless-ngx), and thank you!
 
 ## Scanners & Software
 

docs/usage.md

@@ -103,25 +103,14 @@ Typically, you're looking at an FTP server like
 
 ### Web UI Upload
 
-The dashboard has a file drop field to upload documents to paperless.
+The dashboard has a button to upload documents to paperless or you
-Simply drag a file onto this field or select a file with the file
+can simply drag a file anywhere into the app to initiate the consumption
-dialog. Multiple files are supported.
+process.
-
-You can also upload documents on any other page of the web UI by
-dragging-and-dropping files into your browser window.
 
 ### Mobile upload {#usage-mobile_upload}
 
-The mobile app over at [https://github.com/qcasey/paperless_share](https://github.com/qcasey/paperless_share)
+Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Affiliated-Projects) for a user-maintained list of affiliated projects and
-allows Android users to share any documents with paperless. This can be
+software (e.g. for mobile devices) that is compatible with Paperless-ngx.
-combined with any of the mobile scanning apps out there, such as Office
-Lens.
-
-Furthermore, there is the [Paperless
-App](https://github.com/bauerj/paperless_app) as well, which not only
-has document upload, but also document browsing and download features.
-
-Another option is [Paperless Mobile](https://github.com/astubenbord/paperless-mobile), an Android app that supports document upload, scanning, management of labels and more.
 
 ### IMAP (Email) {#usage-email}
 
@@ -145,9 +134,9 @@ These rules perform the following:
 5.  If documents were consumed from a mail, the rule action is performed
     on that mail.
 
-Paperless will completely ignore mails that do not match your filters.
+Paperless will check all emails only once and completely ignore messages
-It will also only perform the action on mails that it has consumed
+that do not match your filters. It will also only perform the rule action
-documents from.
+on e-mails that it has consumed documents from.
 
 The actions all ensure that the same mail is not consumed twice by
 different means. These are as follows:
@@ -354,6 +343,19 @@ The following custom field types are supported:
 - `Number`: float number e.g. 12.3456
 - `Monetary`: float number with exactly two decimals, e.g. 12.30
 
+## Share Links
+
+Paperless-ngx added the abiltiy to create shareable links to files in version 2.0. You can find the button for this on the document detail screen.
+
+- Share links do not require a user to login and thus link directly to a file.
+- Links are unique and are of the form `{paperless-url}/share/{randomly-generated-slug}`.
+- Links can optionally have an expiration time set.
+- After a link expires or is deleted users will be redirected to the regular paperless-ngx login.
+
+!!! tip
+
+    If your paperless-ngx instance is behind a reverse-proxy you may want to create an exception to bypass any authentication layers that are part of your setup in order to make links truly publicly-accessible. Of course, do so with caution.
+
 ## Best practices {#basic-searching}
 
 Paperless offers a couple tools that help you organize your document
@@ -645,16 +647,3 @@ Paperless-ngx consists of the following components:
 
 - Optional: A database server. Paperless supports PostgreSQL, MariaDB
   and SQLite for storing its data.
-
-## Share Links
-
-Paperless-ngx added the abiltiy to create shareable links to files in version 2.0. You can find the button for this on the document detail screen.
-
-- Share links do not require a user to login and thus link directly to a file.
-- Links are unique and are of the form `{paperless-url}/share/{randomly-generated-slug}`.
-- Links can optionally have an expiration time set.
-- After a link expires or is deleted users will be redirected to the regular paperless-ngx login.
-
-!!! tip
-
-    If your paperless-ngx instance is behind a reverse-proxy you may want to create an exception to bypass any authentication layers that are part of your setup in order to make links truly publicly-accessible. Of course, do so with caution.

mkdocs.yml

@@ -42,6 +42,7 @@ markdown_extensions:
   - pymdownx.superfences
   - pymdownx.inlinehilite
   - pymdownx.snippets
+  - footnotes
 strict: true
 nav:
     - index.md
@@ -64,3 +65,5 @@ extra:
       link: https://hub.docker.com/r/paperlessngx/paperless-ngx
     - icon: material/chat
       link: https://matrix.to/#/#paperless:matrix.org
+plugins:
+  - glightbox