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.

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

docs: add detailed field descriptions to Config struct #4070

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

VolodymyrBg
Copy link

This commit adds comprehensive documentation for each field in the Config struct
in nodebuilder/config.go. The documentation helps users understand the purpose
and functionality of each configuration section, making it easier to configure
and maintain Celestia nodes.

Each field now includes a detailed comment that explains:

  • What the configuration section controls
  • Key functionality managed by that section
  • Any node-type specific considerations (e.g., DASer for Light/Full nodes)

This addresses the TODO comment that requested field descriptions to help users
understand the purpose of each configuration field.

Resolves TODO(@Wondertan): Add field descriptions for Config struct

@github-actions github-actions bot added the external Issues created by non node team members label Jan 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
external Issues created by non node team members
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant