Skip to content

docs: enhance object-store and object-tree READMEs with extensive documentation#69

Merged
pyramation merged 3 commits into
mainfrom
docs/readme-updates
May 18, 2026
Merged

docs: enhance object-store and object-tree READMEs with extensive documentation#69
pyramation merged 3 commits into
mainfrom
docs/readme-updates

Conversation

@pyramation
Copy link
Copy Markdown
Contributor

@pyramation pyramation commented May 18, 2026

Summary

Documentation-only PR. Significantly expands the READMEs for object-store (194→497 lines) and object-tree (191→377 lines) with extensive technical documentation. Minor style consistency fix for partman.

object-store:

  • New overview section weaving in the Egypt origin story and Rich Hickey / Datomic inspiration
  • Tagline now cross-links to @pgpm/object-tree via npm
  • Added Core Concepts sections: object table schema, content-addressable hashing, structural sharing (with ASCII diagram), immutability & freezing
  • Expanded all 8 public function docs with full signatures, parameter descriptions, and usage examples
  • Added Usage Examples section (virtual filesystem, version comparison, multi-tenant isolation)
  • Added Database Schema section (schemas, indexes, triggers)
  • Added "See Also" section linking to @pgpm/object-tree via npm
  • Expanded Related Tooling to match utils/jwt-claims style

object-tree:

  • New overview connecting to object-store's philosophy with Egypt/Datomic narrative
  • Tagline now cross-links to @pgpm/object-store via npm
  • Added Core Concepts: stores, commits (with field table), refs (with field table), scope vs store isolation
  • Expanded all 5 public function docs with full signatures and usage examples
  • Added Usage Examples (repo setup workflow, time travel via commit history, multiple stores per scope)
  • Added Database Schema section (tables, schemas)
  • Dependencies now link to @pgpm/object-store and @pgpm/verify via npm with descriptions
  • Expanded Related Tooling to match other packages

partman:

  • Added period to tagline for consistency
  • Bolded and expanded Related Tooling descriptions to match sibling packages

Review & Testing Checklist for Human

  • Egypt/Datomic narrative tone: Read the overview paragraphs in both object-store and object-tree and confirm the personal origin story reads the way you want it to. This is subjective — only you can validate it.
  • Structural sharing diagram accuracy (object-store): The ASCII diagram shows C as a child of A, but after updating C→C', A is shown unchanged while B→B' changes despite its child E not changing. If C is truly under A, then A should also become A' (its kids array changed). Verify the diagram matches your mental model and fix if needed.
  • Function signatures match actual SQL: Spot-check that parameter names (s_id, store_id, refname, etc.), return types, and default values in the docs match the deployed SQL. The s_id rename (from the prior scope_ids_id parameter rename) should be consistently reflected.
  • npm cross-reference links: Both packages now link to each other in their taglines, Dependencies, and See Also sections via https://www.npmjs.com/package/@pgpm/.... These may 404 until the packages are published to npm.

Notes

  • No code changes — README-only. CI should be unaffected.
  • Function documentation was written by reading the actual SQL deploy files in the repo, but the examples were not executed against a live database.
  • The partman README was already in good shape; changes there are cosmetic only.

Link to Devin session: https://app.devin.ai/sessions/eecca6759b5c456186f6f0e21a48684f
Requested by: @pyramation

…umentation

- object-store: Added rich overview weaving in Egypt origin story and Rich
  Hickey/Datomic inspiration, detailed Core Concepts section (object table,
  content-addressable hashing, structural sharing, immutability/freezing),
  full function signatures and usage for all 8 public functions, usage
  examples (virtual filesystem, version comparison, multi-tenant isolation),
  database schema details (schemas, indexes, triggers), and expanded
  Related Tooling section

- object-tree: Added overview connecting to object-store's philosophy with
  Egypt/Datomic narrative, detailed Core Concepts section (stores, commits,
  refs, scope vs store isolation), full function signatures and usage for
  all 5 public functions, usage examples (repo setup, time travel, multiple
  stores), and database schema details

- partman: Minor style consistency updates to match other package READMEs
@devin-ai-integration
Copy link
Copy Markdown

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@pyramation pyramation merged commit 265bd65 into main May 18, 2026
24 checks passed
@pyramation pyramation deleted the docs/readme-updates branch May 18, 2026 02:45
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