Connect a documents folder

Add a folder of documents to a project. Revetly reads every Markdown file in it on its next read pass.

Before you start

• Add your first project from the page
• Put at least one Markdown file, ending in .md, in the folder.

Configuration page

1. Open the configuration page. If it is not open, run revetly config and open the address it prints.

2. On the project's card, go to Documents and select Change.

3. Select Browse.

4. Select Up until the picker lists the folder you want.

5. Tick the folder, then select Add 1 folder.

6. Select Save.

   You should see Documents: docs · notes on the card.

7. Select Test connection on the Documents line.

   You should see Revetly can read this folder.

Command line

1. In revetly.toml at the project root, add the folder to roots under [docs]:

   # revetly.toml
   [docs]
   roots = ["docs", "notes"]
   

2. Confirm Revetly can read it:

   revetly doctor --offline
   

   [PASS] source roots   docs, notes, …
   

Troubleshooting

• The picker does not list the folder. The engine cannot reach it from where it runs. Choose a folder under the project root.
• The page shows no project card. No folder this project declares holds a document yet. Put one file under a declared folder and reload the page.

Next steps

• Connect private git repositories with one credential
• Price and run the first pass, and know it landed