docs
docs copied to clipboard
docs: Document the node's store structure clearly
Not sure if this is already done, but I looked through docs and was unable to find.
We should document the node's datastore and its contents.
can you please provide more context? where should i reference to document this, do you have a tree of datastore with descriptions already, or specs i could use?
@renaynay gm!
bumping this again @renaynay and @Wondertan
Hey sorry, what I meant by this was documenting which directories relate to which structures
e.g. /blocks
stores blocks, /data
is headers etc.
got it. I will begin drafting here
/blocks
- stores blocks
/data
stores headers
/config
stores:
-
app.toml
- what are these 3 for? -
client.toml
-
config.toml
/config.toml
is node config
/inverted_index
- what is the correct definition for this @renaynay?
/keys
- stores keys
/transients
- what is the correct definition for this?
Hi! @jcstein can I work on this?
absolutely @Mackenzie-OO7 !
@jcstein please where do you suggest I should put this in the docs?
do you think "run a node" -> "resources" -> "celestia-node" is a good spot?
do you think "run a node" -> "resources" -> "celestia-node" is a good spot?
Yes! that's what I had in mind