Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Document the node's store structure clearly #1341

Open
renaynay opened this issue Dec 21, 2023 · 10 comments · Fixed by #1766 · May be fixed by #1603
Open

docs: Document the node's store structure clearly #1341

renaynay opened this issue Dec 21, 2023 · 10 comments · Fixed by #1766 · May be fixed by #1603
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@renaynay
Copy link
Member

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.
@jcstein
Copy link
Member

jcstein commented Dec 22, 2023 •
edited
Loading

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 jcstein added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 22, 2023
@jcstein
Copy link
Member

jcstein commented Jan 30, 2024

@renaynay gm!

@jcstein
Copy link
Member

jcstein commented Feb 5, 2024

bumping this again @renaynay and @Wondertan

@renaynay
Copy link
Member Author

renaynay commented Feb 5, 2024

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

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

@jcstein jcstein added good first issue Good for newcomers help wanted Extra attention is needed labels Mar 21, 2024
@jcstein
Copy link
Member

jcstein commented Mar 28, 2024 •
edited
Loading

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?

@Mackenzie-OO7
Copy link
Contributor

Hi! @jcstein can I work on this?

@jcstein
Copy link
Member

jcstein commented May 2, 2024

absolutely @Mackenzie-OO7 !

@Mackenzie-OO7
Copy link
Contributor

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

@jcstein
Copy link
Member

jcstein commented May 14, 2024

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

@Mackenzie-OO7
Copy link
Contributor

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

Yes! that's what I had in mind

@Mackenzie-OO7 Mackenzie-OO7 linked a pull request Jun 10, 2024 that will close this issue
Open
@jcstein jcstein mentioned this issue Oct 24, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
3 participants
@renaynay @jcstein @Mackenzie-OO7