Skip to content

Document that scaffold always creates suite structural folders #2

Description

@abhinavgautam01

Description

When a user specifies a custom workspace.folders list, maxed init still creates additional suite structural directories such as configs/, workpapers/, fixtures/ and pipeline/.

This is not necessarily incorrect behavior because those directories are used for the generated workspace config, example workpapers, fixture data and runnable pipeline. However, the current schema/README wording can make workspace.folders sound like the complete set of directories that will be created.

Evidence

Given:

workspace:
  root: ./ws
  folders:
    - exports

maxed init creates:

configs/
exports/
fixtures/
pipeline/
workpapers/

Why this is confusing

The configured exports/ folder is created, but the scaffold also creates fixed suite-wiring folders via generated files:

  • configs/workspace.json
  • workpapers/example.workpaper.json
  • workpapers/example.close-checklist.json
  • fixtures/statement.csv
  • pipeline/import_transactions.py

Suggested Fix

Clarify the documentation/schema description so workspace.folders is understood as additional/requested workspace folders, not an exhaustive allowlist of every directory maxed init may create.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions