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: Update node config comments so that they can be used for doc generation. #5729

Merged
merged 1 commit into from
Sep 26, 2023

Conversation

winder
Copy link
Contributor

@winder winder commented Sep 5, 2023

Summary

Updating comments on config.Local so that they can be used to generate the node configuration page. Here I've mainly chosen the best content from the developer portal and the existing comments.

Followup PRs should be made:

  • Better and more consistent formatting. Especially in cases where multiple options are listed.
  • Remove unused settings. I noticed at least 5 which don't seem to be used. I only marked the ones which had minimal or missing documentation.
  • Generally going through the entire list to clarify and update documentation as needed.

Test Plan

Manually ran the config_json_gen and verified that the generated markdown document looks good and has no warnings.

@winder winder requested review from cce and algorandskiy September 5, 2023 18:46
config/localTemplate.go Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Sep 5, 2023

Codecov Report

Merging #5729 (2552392) into master (02b99bb) will increase coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5729      +/-   ##
==========================================
+ Coverage   55.54%   55.57%   +0.03%     
==========================================
  Files         476      476              
  Lines       66853    66853              
==========================================
+ Hits        37131    37154      +23     
+ Misses      27193    27182      -11     
+ Partials     2529     2517      -12     
Files Changed Coverage Δ
config/localTemplate.go 69.12% <ø> (ø)

... and 16 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@winder winder changed the title Update node config comments so that they can be used for doc generation. docs: Update node config comments so that they can be used for doc generation. Sep 26, 2023
@winder winder self-assigned this Sep 26, 2023
config/localTemplate.go Show resolved Hide resolved
@winder winder marked this pull request as ready for review September 26, 2023 15:15
@winder winder merged commit 37baa52 into algorand:master Sep 26, 2023
@winder winder deleted the will/config-sync branch September 26, 2023 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants