Skip to content

docs: reconcile documentation to current code state#30

Merged
saagpatel merged 1 commit into
mainfrom
docs/truth-up-land-2026-06-02
Jun 3, 2026
Merged

docs: reconcile documentation to current code state#30
saagpatel merged 1 commit into
mainfrom
docs/truth-up-land-2026-06-02

Conversation

@saagpatel
Copy link
Copy Markdown
Owner

Documentation reconciled to current code state by the /doc-truth-up pass (docs-only: README/CLAUDE/AGENTS/DOC-RECONCILIATION + docs/**). Surgically cherry-picked so only the reconciliation lands.

- README.md: rewrite from template framing to actual Job Command Center
  app (correct title, full v1.0 feature list, Python sidecar in stack,
  pnpm install, Node 20+)
- AGENTS.md: correct app identity (template → JCC), npm → pnpm throughout,
  update verification commands to pnpm equivalents
- CLAUDE.md: fix Portfolio Context "How To Run" block (npm → pnpm)
- docs/CONTRIBUTING.md: Node 18+ → 20+, npm → pnpm throughout
- docs/userguide/userguide.md: full rewrite from template placeholder to
  JCC user guide (Tracker, Submit Console, Follow-up Manager, Interview
  Prep, Analytics, Settings, keyboard shortcuts)
- DOC-RECONCILIATION.md: reconciliation record with all findings
@saagpatel saagpatel merged commit 02c7d0b into main Jun 3, 2026
@saagpatel saagpatel deleted the docs/truth-up-land-2026-06-02 branch June 3, 2026 03:12
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6c36a5e40b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


| Platform | Method | Notes |
| ---------- | ----------------- | ---------------------------------------------- |
| Ashby | API | Requires Ashby API key in Settings → Credentials |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove nonexistent Ashby key setup path

In the current Settings → Credentials UI, the only API key field is ANTHROPIC_KEY; there is no Ashby key control, and the sidecar registers AshbyAdapter() without passing any key. Users following this row cannot actually add the required Ashby credential in the documented place, so Ashby setup remains impossible from the UI.

Useful? React with 👍 / 👎.

## Interview Prep

Press **Cmd+,** to open preferences:
A brief is auto-generated when a job status moves to **Interviewing**.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Don't claim interview briefs are auto-generated

When a job moves to interviewing, the backend only creates an empty interview_prep note; the React view still shows a prompt to click “Generate Prep Brief” before any AI content is produced. This sentence tells users to expect an automatic brief that the current workflow never creates.

Useful? React with 👍 / 👎.

- **Ashby API key** — required for Ashby submissions.
- **Gmail** — authenticate OAuth to enable follow-up sending.

All secrets are stored in macOS Keychain, never on disk.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Don't say all secrets stay out of disk storage

The Gmail flow explicitly stores client_secrets.json under ~/.jcc/gmail/ and writes the OAuth token to ~/.jcc/gmail/token.json in GmailService.authorize, so this blanket assurance is false for Gmail credentials. Users relying on this for security expectations would misunderstand where sensitive OAuth material is stored.

Useful? React with 👍 / 👎.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant