Index API and AvalancheGo Configs Docs Fix #3632
Conversation
config/config.md
Outdated
| ```go | ||
| { |
There was a problem hiding this comment.
Hmm, so if this is trying to look like a json definition, I think we would want the tabs/spaces right?
There was a problem hiding this comment.
my md linter hated the tab, code block was also labelled ```go. fixed
config/config.md
Outdated
| @@ -263,122 +263,122 @@ As an alternative to `--db-config-file`, it allows specifying base64 encoded dat | |||
| A LevelDB config file must be JSON and may have these keys. | |||
| Any keys not given will receive the default value. | |||
|
|
|||
| ```go | |||
| ```json | |||
There was a problem hiding this comment.
This isn't valid json either (and the github visual of this block does not like that it is marked as json)
There was a problem hiding this comment.
it's not a valid json because of the comments? either way this doc is completely non functional. Would rather please .md standards than GH because this doc is hosted on our dev docs
There was a problem hiding this comment.
Maybe have it as text? 🤔 Maybe json gets rendered as extended json depending on the rendering engine...
There was a problem hiding this comment.
text removes all color-coding which makes it a bit harder to read.
There was a problem hiding this comment.
I readded the tab and set the codeblock back to go.
There was a problem hiding this comment.
…andling (#3574) Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com> Signed-off-by: Meaghan FitzGerald <meag.fitz@avalabs.org> Co-authored-by: Stephen Buttolph <stephen@avalabs.org> Co-authored-by: Meaghan FitzGerald <meag.fitz@avalabs.org>
Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com> Signed-off-by: Meaghan FitzGerald <meag.fitz@avalabs.org> Co-authored-by: aaronbuchwald <aaron.buchwald56@gmail.com> Co-authored-by: Stephen Buttolph <stephen@avalabs.org>
Why this should be merged
Many broken links exist in these docs, and the "configs" doc is hard to navigate due to a lack of order
How this works
Edited
/indexer/service.goandconfig/config.mdHow this was tested
previewed in code editor. Changes will be visible on docs.avax.network after this PR is merged and the docs build is triggered.
Need to be documented in RELEASES.md?
no