Improve documentation for JSON configuration options

[AbhinavS8]

I was trying to modify some of the parameters in the JSON config (like compactType under display module) and noticed there wasn't much documentation for the options except for the JSON schema. The schema is helpful for validation, but it doesn't explain what the available values do. Would documenting the various parameters be something useful for this project? Something like:

-What each parameter controls
-available values (where applicable)
-default value
-examples

If so I'd like to work on adding docs for the config modules. Or inline comments in the JSONC itself.

[nickioann]

Hi!! Yeah I think it would be really helpful, especially when wanting to change primary secondary or even third colours on a logo and I had to do some digging until I found out that before the R;G;B values you had to add 38;2 for it to work, bottom line is that I think it would be a nice addition to have parameter documentation! (Note; I'm new to Linux so I won't be able to answer everything correctly)

[CarterLi]

especially when wanting to change primary secondary or even third colours on a logo and I had to do some digging until I found out that before the R;G;B values you had to add 38;2 for it to work

It's documented in https://github.com/fastfetch-cli/fastfetch/wiki/Color-Format-Specification

If you don't want to read the wiki then no one can help you.

[CarterLi]

but it doesn't explain what the available values do

There is a description for every possible values I guess?

fastfetch/doc/json_schema.json

Lines 2367 to 2396 in 8bf1aca

	"compactType": {
	"description": "Whether to print all displays on a single line",
	"oneOf": [
	{
	"const": null,
	"description": "Disable compact mode"
	},
	{
	"const": "none",
	"description": "Disable compact mode (kept for compatibility)"
	},
	{
	"const": "original",
	"description": "Print original resolutions"
	},
	{
	"const": "scaled",
	"description": "Print scaled resolutions"
	},
	{
	"const": "original-with-refresh-rate",
	"description": "Print original resolutions with refresh rates"
	},
	{
	"const": "scaled-with-refresh-rate",
	"description": "Print scaled resolutions with refresh rates"
	}
	],
	"default": null
	},

Both neovim (with a proper configuration), helix and vscode can correctly display the description on the fly when you typing

[CarterLi]

Would documenting the various parameters be something useful for this project?

JSON schema is the document. If you find there is something missing or not clear in the schema, you are welcome to fix that. There are wiki too, but for module parameters they should stay in the schema to minimize‌ maintenance cost.

I had a plan to make a config generation tool based on the JSON schema. With the help of AI it should not be hard. If you want to help you can try it.

[nickioann]

especially when wanting to change primary secondary or even third colours on a logo and I had to do some digging until I found out that before the R;G;B values you had to add 38;2 for it to work

It's documented in https://github.com/fastfetch-cli/fastfetch/wiki/Color-Format-Specification

If you don't want to read the wiki then no one can help you.

---

I do want to read it I just didn't know exactly where to look, thanks for showing me this!

[AbhinavS8]

There is a description for every possible values I guess?

Yes, I apologize, I should've checked the repository in more detail before concluding that there was no info. I checked the auto generated schema in the wiki, then went straight to the source code files.

JSON schema is the document. If you find there is something missing or not clear in the schema, you are welcome to fix that. There are wiki too, but for module parameters they should stay in the schema to minimize‌ maintenance cost.

After going through the actual schema I didn't notice anything missing in it. I just thought it would be useful to add it to the wiki so it would be easier to access. I'll keep in mind the maintenance costs next time.

I had a plan to make a config generation tool based on the JSON schema. With the help of AI it should not be hard. If you want to help you can try it.

I'd like to work on that. Do you have any overall ideas in mind already?