Skip to content

docs: add board pack schema changelog - #30

Open
sethuramansethu008-debug wants to merge 2 commits into
TelivityAI:mainfrom
sethuramansethu008-debug:docs/board-pack-changelog
Open

docs: add board pack schema changelog#30
sethuramansethu008-debug wants to merge 2 commits into
TelivityAI:mainfrom
sethuramansethu008-debug:docs/board-pack-changelog

Conversation

@sethuramansethu008-debug

Copy link
Copy Markdown

Summary

Adds documentation for the CareerOps board pack schema from v1 → v5.

Type

  • Bug fix
  • Feature
  • Docs / deploy
  • Chore

Changes

  • Added docs/BOARD_PACK.md with the v1 → v5 schema changelog.
  • Documented the fields introduced by each schema version based on the migrators.
  • Documented that API keys and secrets are never exported or imported.
  • Linked BOARD_PACK.md from docs/README.md.
  • Linked BOARD_PACK.md from web/README.md.

Checklist

  • No secrets or personal data in the diff
  • Docs updated
  • I agree this contribution is under Apache-2.0

Closes #18

@telivity-otaip telivity-otaip left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you for taking #18 — the changelog table is the right shape, and the v1→v5 field list matches the migrators. That’s the useful part.

Two fixes before we can merge, please:

  1. Restore web/README.md from main. It currently drops configure, deploy, schema, and the Edge functions section. #18 only asked for a link from the existing Export/import bit.
  2. Un-escape docs/BOARD_PACK.md — the \# / \*\* / \_ and extra blank lines keep it from rendering as markdown.

Happy to merge once those land. Appreciate the careful read of the migrators.

Comment thread web/README.md Outdated
| `clear_provider_secret` | Settings when removing a stored provider secret. | **Optional.** Same plaintext fallback as above. |

**Minimal viable install:** none of the 9 functions are strictly required. Core board operations (add/drag/tag roles, verdicts, outcomes, notes) call Supabase tables directly (`sb.from('mt_roles')`, etc.), not Edge Functions. Search and JD auto-fetch need `run-search-mt` / `fetch-jd`; AI scoring/tailoring/chat need the rest (or a BYO OpenAI-compat key to skip those three client-side); secret vault helpers are only needed if you want encrypted Settings storage instead of plaintext profile columns.
cp config.example.js config.js No newline at end of file

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like this file got truncated — configure / deploy / schema / the Edge functions section from #15 all disappeared. #18 only asked for a link from the existing Export/import section, not a rewrite of this README. Could you restore web/README.md from main and add a single link to docs/BOARD_PACK.md there?

Comment thread docs/BOARD_PACK.md Outdated
@@ -0,0 +1,104 @@
\# CareerOps Board Pack Schema

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The v1→v5 table content looks right vs the migrators — thank you. The markdown itself is escaped though (\#, \*\*, \_), so GitHub will render the backslashes instead of headings/bold. Could you un-escape those and tighten the extra blank lines so this reads as normal markdown?

@sethuramansethu008-debug

Copy link
Copy Markdown
Author

Fixed both requested changes:

  • Restored web/README.md from main and added the Board Pack schema link under Export / import.
  • Un-escaped and cleaned up docs/BOARD_PACK.md so it renders correctly as Markdown.

Pushed the fixes in commit a6c9671. Thanks for the review!

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.

Docs: board pack schema changelog (v1 → v5) for importers

2 participants