A-IForgeEngineDocsReference4. Documentation Installer

Run:

Forge: Install Documentation

Forge installs bundled documentation and examples directly into your vault.

The installer copies markdown from the plugin's internal:

docs/
examples/

folders into your configured Forge workspace.


Install Documentation

Install Targets

Plugin Source FolderInstalled Vault Folder
docs/A-I/Forge/Engine/Docs
examples/A-I/Forge/Engine/Examples

Subfolders are preserved during installation.

Example:

docs/getting-started/1. Quick Start.md

installs as:

A-I/Forge/Engine/Docs/getting-started/1. Quick Start.md

This allows Forge documentation and examples to stay organized instead of flattening everything into one folder.


Installed Structure

Typical installed structure:

A-I/Forge/Engine/
├── Docs/
├── Examples/
├── Exports/
├── Shapes/
└── Patches/

Installed Docs

Why Docs Live Inside the Vault

Forge installs documentation directly into the vault because vault-based docs are:

  • searchable
  • linkable
  • editable
  • syncable
  • usable offline

They behave like normal Obsidian notes.

You can:

  • bookmark them
  • annotate them
  • customize them
  • link to them
  • move them
  • copy sections into your own workflows

The goal is for the docs to become part of the vault itself instead of a disconnected external manual.


No Overwrites

The installer skips files that already exist.

This protects:

  • local edits
  • annotations
  • customized examples
  • modified workflows

Forge intentionally treats installed docs as user-owned content after installation.

To reinstall a specific file:

  1. rename or delete the installed copy
  2. run:
    Forge: Install Documentation
    
  3. Forge installs the missing file again

Placeholder Replacement

Docs and examples support placeholder values that are replaced during installation.

This allows examples and walkthroughs to match the user's configured Forge paths automatically.

PlaceholderReplaced With
2026-07-21Install date
A-I/Forge/EngineForge root folder
A-I/Forge/Engine/DocsInstalled docs folder
A-I/Forge/Engine/ExamplesInstalled examples folder
A-I/Forge/Engine/PatchesPatches folder
A-I/Forge/Engine/Patches/vault-patch.mdDefault patch note
A-I/Forge/Schema/schema.mdSchema note path
A-I/Forge/ExportsExports folder
A-I/Forge/InboxInbox folder
A-I/Forge/ShapesShapes folder

This keeps installed documentation aligned with the user's actual configuration.


Frontmatter Handling

Forge automatically adds standard frontmatter to installed docs and examples.

Source markdown files inside the plugin repository do not need frontmatter unless you intentionally want visible frontmatter text rendered inside the installed note body.

This helps keep source documentation cleaner and easier to maintain.


Examples Are Meant to Be Modified

The Examples folder is intentionally practical.

These are not abstract demos.

They are designed to be:

  • copied
  • modified
  • adapted
  • reused

Examples include:

  • starter schemas
  • patch workflows
  • repair examples
  • export workflows
  • shape systems
  • maintenance routines

Most users should start from examples instead of building everything from scratch.


Examples Folder

Recommended Next Reads

Built with LogoFlowershow