Skip to content

[Feature]: Add data/profile.example.json so users see the schema #12

Description

@Aditya-00a

What problem does this solve?

Users who skip python setup.py profile (or who want to hand-edit later) need to know the exact JSON schema for data/profile.json and data/master-resume.json. Right now they have to read Pydantic models in backend/models/schemas.py.

What to do

Add two example files:

  • agent/data/profile.example.json — a complete, fictional sample profile with every field populated
  • agent/data/master-resume.example.json — same, with a fake person's experience history

Use a clearly fake identity (e.g. "Jane Doe", "jane@example.com", "Acme University", "BigCo Inc.") so nobody mistakes it for a real person.

Proposed solution

Acceptance

  • Both files exist and parse as valid JSON
  • All fields the wizard writes are present
  • README / QUICKSTART has a one-line note: "To skip the wizard, copy data/profile.example.json to data/profile.json and edit."

Alternatives you considered

No response

Are you up for contributing this?

  • Yes, I'd like to send a PR
  • Yes, with some guidance
  • No, just suggesting

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

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions