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

Centralize and elevate configuration documentation #1888

Open
jmooring opened this issue Nov 13, 2022 · 1 comment
Open

Centralize and elevate configuration documentation #1888

jmooring opened this issue Nov 13, 2022 · 1 comment

Comments

@jmooring
Copy link
Member

jmooring commented Nov 13, 2022

This would be a major change, so we should not act on this without bep's approval.

Currently the configuration documentation is spread around throughout the site. I propose creating a section for configuration, with a page for each of the configuration tables: root, markup, taxonomies, menus, params, etc.

This section would be located near the bottom, as a reference. It would be nice if docs.json, generated from source, contained the defaults for all of the keys.

Also incorporate intent from:

@jmooring jmooring changed the title Promote "Configuration" to a section Promote Configuration to a section Nov 7, 2023
@jmooring jmooring changed the title Promote Configuration to a section Centralize and elevate configuration documentation Nov 7, 2023
@jmooring jmooring removed the Proposal label Nov 7, 2023
@bep
Copy link
Member

bep commented Oct 29, 2024

This section would be located near the bottom, as a reference. It would be nice if docs.json, generated from source, contained the defaults for all of the keys.

I think the above is true now.

As to this issue, I somehow didn't notice it before now, but I certainly agree that creating a section for configuration would make perfect sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants