Skip to content

Getting Started: two different .complytime directories are never disambiguated #67

Description

@trevor-vaughan

Summary

The page uses .complytime to mean two different locations — a global cache under $HOME
and per-workspace state in the current directory — with the same name and no explanation.
This is easy to conflate.

Affected

  • Page: content/docs/getting-started/_index.md (lines 74, 102 for ~/.complytime/…;
    lines 132 and the init flow for ./.complytime/…)

Detail

  • ~/.complytime/providers/ and ~/.complytime/policies/ are under $HOME (global).
  • init writes ./.complytime/complytime.yaml and scans write to ./.complytime/scan/,
    both in the current working directory (per-workspace).

Same directory name, two locations, opposite scopes, with nothing on the page distinguishing
them.

Suggested fix

Add one sentence distinguishing the two: a global cache in $HOME/.complytime (providers,
policy cache) versus per-workspace state in ./.complytime (workspace config, scan output).

Issue created with the help of Claude Opus 4.6

Metadata

Metadata

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Type

No type

Fields

Priority

None yet

Effort

None yet

Projects

Status
Ready for Review 👀

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions