Skip to content

docs: clarify configured data directories in setup and reference pages #68

Description

@nikitacometa

The Quick Start assumes the default workspace layout, while the FAQ and glossary describe User Layer ownership without explaining custom data directories. Split-data users would benefit from an explicit path reference.

Clarify that cv.md and interview-prep/story-bank.md live inside the configured data directory, which defaults to the repository root. Document precedence: CAREER_OPS_ROOT, then CAREER_OPS_DATA_DIR, then .career-ops-data; relative configured roots resolve against the repository root.

Scope: content/docs/index.mdx, content/docs/faq.mdx, and content/docs/reference/glossary.mdx, with matching definitions in src/lib/faq-data.ts and src/lib/glossary-data.ts. Check localized equivalents for consistency.

This is an existing Data Contract clarification: https://github.com/career-ops-hq/career-ops/blob/main/DATA_CONTRACT.md. It came up in career-ops-hq/career-ops#3972 (comment). Any wording promising that story-provenance-check.mjs honors this contract should wait until the PR is merged and its fix is available in a release; the general data-directory explanation can ship independently.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions