Dev-tooling Configuration

Configuring the `docopslab-dev.yml` manifest for DocOps Lab development tooling

This guide pertains to the docopslab-dev environment. For complete documentation, see the project’s README.

The environment described and provided here is not optimized for DocOps Lab applications used in third-party projects. For your own applications of DocOps Labs products like ReleaseHx and Issuer, see DocOps Box for a full-featured docs-focused workspace, runtime, and production environment.

For dev-tooling setup instructions, see DocOps Lab Dev-tooling Setup.

For dev-tooling usage instructions, see DocOps Lab Dev-tooling Usage.

Initialization automatically creates .config/docopslab-dev.yml, which you can edit, or you can create it manually.

source:
  repo: DocOps/lab
  ref: v1
  root: gems/docopslab-dev/assets/config-packs

docs:
  - source: docs/agent/AGENTS.md
    target: AGENTS.md
    synced: false
  - source: docs/agent/skills/*.md
    target: .agent/docs/skills/
    synced: true
  - source: docs/agent/topics/*.md
    target: .agent/docs/topics/
    synced: true
  - source: docs/agent/roles/*.md
    target: .agent/docs/roles/
    synced: true

tools:
  - tool: rubocop
    files:
      - source: rubocop/base.yml
        target: .config/.vendor/docopslab/rubocop.yml
        synced: true
      - source: rubocop/project.yml
        target: .config/rubocop.yml
        synced: false

  - tool: vale
    files:
      - source: vale/base.ini
        target: .config/.vendor/docopslab/vale.ini
        synced: true
      - source: vale/project.ini
        target: .config/vale.local.ini
        synced: false

  - tool: htmlproofer
    enabled: false  # Disabled by default, enable per project
    files:
      - source: htmlproofer/base.yml
        target: .config/.vendor/docopslab/htmlproofer.yml
        synced: true
      - source: htmlproofer/project.yml
        target: .config/htmlproofer.yml
        synced: false
    paths:
      lint: docs/_site

  - tool: shellcheck
    files:
      - source: shellcheck/base.shellcheckrc
        target: .config/shellcheckrc
        synced: true
  
  - tool: actionlint
    files:
      - source: actionlint/base.yml
        target: .config/.vendor/docopslab/actionlint.yml
        synced: true
      - source: actionlint/project.yml
        target: .config/actionlint.yml
        synced: false

Properties Reference

tools

(Array) List of tool configurations to enable and manage. Each entry may/must include:

tool

(Slug) Name of the tool, ex:, rubocop, vale, htmlproofer, actionlint, shellcheck.

enabled

(Boolean) Whether to enable this tool’s tasks and git hooks.

files

List of files to init or sync for the tool.

source: Path within the gem where the base config is located, e.g., config-packs/rubocop/base.yml.
target: Path in the project where the file should be synced, e.g., .config/.vendor/docopslab/rubocop.yml.

paths

Repo=specific paths to include or exclude in linting operations for this tool.

lint: (Array) List of paths or glob patterns to lint with this tool.
skip: (Array) List of paths or glob patterns to exclude from linting with this tool.
exts: (Array) List of file extensions to include in linting with this tool.
git_tracked_only: (Boolean) Whether to limit linting to only Git-tracked files.

docs

(Array) List of documentation files to sync from the gem to the target project. Each entry includes:

source

(String) Source path relative to lib/docopslab/ in the gem. Supports glob patterns (e.g., docs/agent/*.md) or specific files.

target

(String) Target path relative to the project root. Can be a directory (e.g., _docs/) or specific file path (e.g., AGENTS.md).

synced

(Boolean) Whether to update existing files on sync.

true - Always overwrite on sync (keeps docs current with gem updates)
false - Create once, preserve user customizations

Documentation Syncing Examples

Customizable template (create once, allow modifications)

docs:
  - source: docs/AGENTS.md
    target: AGENTS.md
    synced: false

Auto-synced agent guides (keep current)

docs:
  - source: docs/agent/*.md
    target: .docopslab-dev/agent/
    synced: true

Mixed strategy (glob + specific override)

docs:
  - source: docs/agent/*.md
    target: _docs/
    synced: true
  - source: docs/agent/ruby.md
    target: _docs/styles/ruby-custom.md
    synced: false

See tool-specific sections in the various guides, such as for Vale (Documentation Style Guide), RuboCop (Ruby Style Guide), and HTMLProofer.