Add documents

Everything goes into the library through one button, the + beside Library on the Docs page. It opens a short wizard that asks “What would you like to add?” and then only the questions that kind of source needs.

#The kinds of source

#Upload a file

1. On the Docs page, press + and choose Upload a document.
2. Choose or drop one or more files. Each file is sent at once, and its build starts.

Limn decides the kind of file from its contents, not its name. An old Word file (.doc) or an RTF file is refused with a note to save it as .docx.

#Add a web page or site

1. Choose Web page or site and paste the page address.
2. In Links to follow, keep This page only, or choose to follow links 1, 2 or 3 levels deep. Limn follows links on the same site only, up to 25 pages, and the whole set becomes one document with a chapter per page.
3. Check the sentence on the last step (“This will add …”) and press Start.

Pages on your company network, such as an intranet wiki, are allowed. Addresses on this computer itself are not. To read a web page again later, use Rebuild in the document’s menu.

#Connect Confluence or Notion

1. Choose Confluence or Notion.
2. On the Connection step, save a token if the workspace has none yet. See Confluence and Notion for what to create.
3. Paste a page address. A space’s home page (Confluence) or a top-level page (Notion) adds the whole wiki; any other page adds it and every page below it, never its siblings.
4. Limn counts the pages first: “This will add 12 pages from Payments handbook.” Press Start.

One document holds up to 100 pages. For a bigger wiki, add its parts as separate documents; the wizard says so when you need to.

#Add a GitHub repository

1. Choose GitHub repository and type the repository as owner/name.
2. Choose a folder, or Whole repository. Each folder shows how many documents it holds.
3. Press Start.

Limn reads the repository with your gh sign-in, on the default branch. It takes markdown and other text documents only, and leaves out code, images, lock files and generated or vendored folders.

Docs offered from your repositories

After a repository syncs, Limn looks at its file list (without reading the files) for folders that look like documentation: a docs, handbook or adr folder, or any folder with several documents and enough words. A README alone never counts. When it finds some, a card on Docs and on Pending asks “Add 2 docs collections from your repositories?”.

Untick any folder you do not want and press Add. Not now hides the card for 30 days. The wizard’s From your repositories choice lists the same folders at any time.

#Keep documents current

Confluence, Notion and GitHub documents are checked for changes about every three hours while the workspace’s library is in use, and just before a review or story check reads them. Only changed pages are read again, and only changed sections are summarised again, so a small edit costs little. If a page cannot be reached, the document keeps its last good version and says “Can’t reach this page in Confluence since …”.

In each document’s menu:

• Refresh now: check for changes now.
• Rebuild: read every page again and summarise afresh.
• Remove…: take the document out of the library, after you confirm.