docs: enhance object-store and object-tree READMEs with extensive documentation#69
Merged
Conversation
…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 EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only PR. Significantly expands the READMEs for
object-store(194→497 lines) andobject-tree(191→377 lines) with extensive technical documentation. Minor style consistency fix forpartman.object-store:
@pgpm/object-treevia npm@pgpm/object-treevia npmutils/jwt-claimsstyleobject-tree:
@pgpm/object-storevia npm@pgpm/object-storeand@pgpm/verifyvia npm with descriptionspartman:
Review & Testing Checklist for Human
Cas a child ofA, but after updatingC→C',Ais shown unchanged whileB→B'changes despite its childEnot changing. IfCis truly underA, thenAshould also becomeA'(its kids array changed). Verify the diagram matches your mental model and fix if needed.s_id,store_id,refname, etc.), return types, and default values in the docs match the deployed SQL. Thes_idrename (from the priorscope_id→s_idparameter rename) should be consistently reflected.https://www.npmjs.com/package/@pgpm/.... These may 404 until the packages are published to npm.Notes
partmanREADME was already in good shape; changes there are cosmetic only.Link to Devin session: https://app.devin.ai/sessions/eecca6759b5c456186f6f0e21a48684f
Requested by: @pyramation