Remove a Document

Keeping your documentation accurate involves not just adding content, but also pruning it. This guide details how to use the aigne doc remove-document command to safely delete documents from your project, ensuring that your documentation set remains clean and relevant.

Overview#

The remove-document command provides an interactive way to select and delete one or more documents from your existing structure. A key feature of this command is its ability to handle cascading deletes; removing a parent document will also remove all of its child documents.

Furthermore, after the selected documents are removed, the tool automatically scans the remaining files for any broken links that pointed to the deleted documents. It then attempts to intelligently fix these links or remove them, ensuring the integrity of your entire documentation set.

Command Usage#

To begin the removal process, navigate to your project's root directory and execute the command:

aigne doc remove-document

You can also use the shorter aliases remove or rm:

aigne doc rm

1. Select and Confirm Documents#

Upon running the command, you will be presented with a list of your current documents, displayed in a hierarchical tree structure. You can navigate this list using the arrow keys and select the documents you wish to remove by pressing the spacebar. Once you have selected all the documents for deletion, press Enter to confirm. If you decide not to remove any documents, you can press Enter with no selections to cancel the operation.

? Select documents to remove (Press Enter with no selection to finish):
❯◯ /overview
 ◯ /getting-started
 ◯ /guides
  ◯ /guides/generating-documentation
  ◯ /guides/updating-documentation
   ◉ /guides/updating-documentation/adding-a-document
   ◉ /guides/updating-documentation/removing-a-document

2. Link Verification and Fixing#

After the documents are deleted, DocSmith automatically scans your remaining documentation for any links that now point to non-existent files. You will be prompted to confirm the automatic fixing of these invalid links.

? Select documents with invalid links to fix (all selected by default, press Enter to confirm, or unselect all to skip):
❯◉ Update Document (/guides/updating-documentation.md) - Invalid Links(2): /guides/adding-a-document, /guides/removing-a-document

3. Review Summary#

Finally, a summary is displayed in your terminal, listing all the documents that were successfully removed and detailing which documents had invalid links fixed.

---
📊 Summary

🗑️  Removed Documents:
   Total: 2 document(s)

   1. /guides/adding-a-document
   2. /guides/removing-a-document

✅ Documents fixed (Removed invalid links):
   Total: 1 document(s)

   1. /guides/updating-documentation
      Invalid links fixed: /guides/adding-a-document, /guides/removing-a-document

This process ensures that removing files is straightforward and does not leave behind broken references in your other documents.

Related Guides#

After tidying up your documentation, you might need to perform other updates. For more information on managing your document structure, please see the following guides: