From 7a8ed9cd5510cfdc4c3b04a336ad89da6a2ff86a Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Wed, 8 May 2024 23:10:32 -0700 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e98e6df4..dadca5b2 100644 --- a/README.md +++ b/README.md @@ -1273,9 +1273,11 @@ ArchiveBox is neither the highest fidelity nor the simplest tool available for s -We use the [GitHub wiki system](https://github.com/ArchiveBox/ArchiveBox/wiki) and [Read the Docs](https://archivebox.readthedocs.io/en/latest/) (WIP) for documentation. +We use the [ArchiveBox GitHub Wiki](https://github.com/ArchiveBox/ArchiveBox/wiki) for documentation. -You can also access the docs locally by looking in the [`ArchiveBox/docs/`](https://github.com/ArchiveBox/ArchiveBox/wiki/Home) folder. +There is also a mirror available on Read the Docs (though it's sometimes outdated). + +You can submit docs changes and suggestions over in our dedicated repo [`ArchiveBox/docs`](https://github.com/ArchiveBox/docs). ## Getting Started @@ -1286,16 +1288,19 @@ You can also access the docs locally by looking in the [`ArchiveBox/docs/`](http - [Configuration](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration) - [Supported Sources](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive) - [Supported Outputs](https://github.com/ArchiveBox/ArchiveBox/wiki#can-save-these-things-for-each-site) +- [Scheduled Archiving](https://github.com/ArchiveBox/ArchiveBox/wiki/Scheduled-Archiving) ## Advanced -- [Troubleshooting](https://github.com/ArchiveBox/ArchiveBox/wiki/Troubleshooting) -- [Scheduled Archiving](https://github.com/ArchiveBox/ArchiveBox/wiki/Scheduled-Archiving) +- [Security Overview](https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview) +- [Cookies & Sessions Setup](https://github.com/ArchiveBox/ArchiveBox/wiki/Chromium-Install#setting-up-a-chromium-user-profile) +- [Setting up Search](https://github.com/ArchiveBox/ArchiveBox/wiki/Setting-up-Search) (ripgrep, Sonic, or FTS5) +- [Setting up Storage](https://github.com/ArchiveBox/ArchiveBox/wiki/Setting-up-Storage) (S3/B2/Google Drive/SMB/NFS/etc.) +- [Setting up Authentication](https://github.com/ArchiveBox/ArchiveBox/wiki/Setting-up-Authentication) (SSO/LDAP/OAuth/etc.) - [Publishing Your Archive](https://github.com/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive) - [Chromium Install](https://github.com/ArchiveBox/ArchiveBox/wiki/Chromium-Install) -- [Cookies & Sessions Setup](https://github.com/ArchiveBox/ArchiveBox/wiki/Chromium-Install#setting-up-a-chromium-user-profile) -- [Security Overview](https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview) - [Upgrading or Merging Archives](https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives) +- [Troubleshooting](https://github.com/ArchiveBox/ArchiveBox/wiki/Troubleshooting) ## Developers