27 Commits

Author SHA1 Message Date
Trenton H
194e5ac189 Documentation: Update documentation to refer only to Docker Compose v2 command (#4650)
* Replaces references to docker-compose (the v1 executable) with docker compose (the v2 plugin) as well as fixing up some referenes between the tool vs the command

* Update docs/setup.md

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>

* Replaces references to docker-compose (the v1 executable) with docker compose (the v2 plugin) as well as fixing up some referenes between the tool vs the command

---------

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
2023-11-20 20:14:33 -08:00
shamoon
82d28bdb64 Documentation: update docs, screenshots ahead of Paperless-ngx v2.0 (#4542)
* Reformat internal links

* Update screenshots, docs & readme

* Use image lightbox

* Fix nested list on docs index

* Add some visual interest to screenshots layout

* Compress images
2023-11-13 14:56:34 +00:00
shamoon
6b0914dbec Merge branch 'main' into dev 2023-09-26 13:33:27 -07:00
shamoon
6d0be20ec7 Documentation enhancement: add direct links for all config vars (#4237) 2023-09-22 11:12:47 -07:00
Trenton H
7574dc1b6d Fixes the documentation for fuzzy matching (#4207) 2023-09-19 07:46:13 -07:00
André Heuer
7d53f8d7d3 Removed parameter, added documentation 2023-08-29 23:09:47 -07:00
Dennis Brakhane
3ce6c0d91a docs: add note about polling when using double-sided collation 2023-08-20 19:51:14 +02:00
mechanarchy
43fe6ef3a4 Add 'doc_pk' to PAPERLESS_FILENAME_FORMAT handling (#3861)
* Add 'doc_pk' to PAPERLESS_FILENAME_FORMAT handling

* Add test for 'doc_pk' filename formatter
2023-07-30 08:30:50 -07:00
Dennis Brakhane
ef749f9a29 Feature: collate two single-sided multipage scans (#3784)
* Feature: collate two single-sided scans

Some ADF only support single-sided scans, making scanning
double-sided documents a bit annoying.

This new feature enables Paperless to do most of the work,
by merging two seperate scans into a single one, collating
the even and odd numbered pages.

* Documentation: clarify that collation is disabled by default

* Apply suggestions from code review

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>

* Address code review remarks

* Grammar fixes

---------

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
2023-07-24 00:29:04 -07:00
mechanarchy
d6d49f2c5a Updates documentation formatting, grammar, links
Correct indentation of lists, code blocks

Update faq.md

Update CONTRIBUTING.md

Update development.md

Update advanced_usage.md

Update administration.md

Update configuration.md

Update configuration.md

Update advanced_usage.md

Update faq.md
2023-07-21 10:17:57 -07:00
andstu
16c03c6ee3 fix: spelling 2023-05-25 00:43:31 -04:00
shamoon
cf9cc07432 Merge pull request #2997 from paperless-ngx/beta
[Beta] Paperless-ngx v1.14.0 Release Candidate 1
2023-04-24 12:04:56 -07:00
Denilson Sá Maia
4a398af51f Whitespace changes, making sure the example is correcly aligned
If desired, we could also replace spaces with [Box-drawing characters](https://en.wikipedia.org/wiki/Box-drawing_character), like this:

```
🗁 Documents folder
├─🗁 2019/                                   # By Year
│ └─🗁 My bank/
│   ├─🗎 Statement January.pdf
│   └─🗎 Statement February.pdf
└─🗁 Insurances/                             # Insurances
  ├─🗁 Healthcare 123/
  │ ├─🗎 2022-01-01 Statement January.pdf
  │ ├─🗎 2022-02-02 Letter.pdf
  │ └─🗎 2022-02-03 Letter.pdf
  └─🗁 Dental 456/
    └─🗎 2021-12-01 New Conditions.pdf
```

But rendering this with proper fixed-width characters can be troublesome on some systems.
2023-04-13 22:03:40 +02:00
shamoon
fc5c05d0bf Merge branch 'main' into dev 2023-04-01 21:08:33 -07:00
Trenton H
726f01435f Improve documentation around barcodes, re-organize configuration and update links 2023-03-15 10:40:10 -07:00
Trenton Holmes
b78d87f44a Adds owner and original name to the possible naming schemes 2023-03-12 15:29:58 -07:00
bsvka
fb51ee07d4 Fix typo 2023-03-11 18:06:12 +01:00
Brandon Rothweiler
352b888bea Add an option to disable matching 2023-02-21 20:01:30 -05:00
Trenton H
c5aa4e7cf6 When a StoragePath is changed, check if related documents require a rename 2023-02-18 12:19:33 -08:00
shamoon
75bfaa57fc Note possible utf8mb3 requirement 2023-02-05 20:17:22 -08:00
Trenton Holmes
88d362309d Documents the change to pre-consume script and improves the readability 2023-01-29 08:37:32 -08:00
Trenton H
88436e963f Add 2 warnings about potential path length issues 2023-01-14 06:33:12 -08:00
tooomm
cf64931013 Docs: Fix leftover issues from conversion (#2172) 2022-12-11 10:12:58 -08:00
tooomm
23a85200c8 fix links 2022-12-11 08:06:17 -08:00
Trenton Holmes
ec4fc1d971 Further cleanup of docs, including fixing autoconvert issues and general cleanups 2022-12-06 10:45:18 -08:00
Michael Shamoon
bbd3849794 Add changes from #2069 2022-12-02 14:48:36 -08:00
Michael Shamoon
71bd46a96a Move docs to material-mkdocs 2022-12-02 14:48:36 -08:00