docs icon indicating copy to clipboard operation
docs copied to clipboard

docs: Document the node's store structure clearly

Open renaynay opened this issue 1 year ago • 10 comments

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.

renaynay avatar Dec 21 '23 16:12 renaynay

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?

jcstein avatar Dec 22 '23 21:12 jcstein

@renaynay gm!

jcstein avatar Jan 30 '24 21:01 jcstein

bumping this again @renaynay and @Wondertan

jcstein avatar Feb 05 '24 15:02 jcstein

Hey sorry, what I meant by this was documenting which directories relate to which structures

e.g. /blocks stores blocks, /data is headers etc.

renaynay avatar Feb 05 '24 16:02 renaynay

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?

jcstein avatar Mar 28 '24 21:03 jcstein

Hi! @jcstein can I work on this?

Mackenzie-OO7 avatar Apr 22 '24 09:04 Mackenzie-OO7

absolutely @Mackenzie-OO7 !

jcstein avatar May 02 '24 14:05 jcstein

@jcstein please where do you suggest I should put this in the docs?

Mackenzie-OO7 avatar May 14 '24 12:05 Mackenzie-OO7

do you think "run a node" -> "resources" -> "celestia-node" is a good spot?

jcstein avatar May 14 '24 16:05 jcstein

do you think "run a node" -> "resources" -> "celestia-node" is a good spot?

Yes! that's what I had in mind

Mackenzie-OO7 avatar May 14 '24 18:05 Mackenzie-OO7