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

Get rid of "list of all configuration variables" #27

Open
rdb opened this issue Oct 12, 2019 · 2 comments
Open

Get rid of "list of all configuration variables" #27

rdb opened this issue Oct 12, 2019 · 2 comments

Comments

@rdb
Copy link
Member

rdb commented Oct 12, 2019

A reference of all variables has no place in a manual. Instead, such a list should be automatically generated as part of the Reference (see #21).

We could have a list of variables under each module generated by the API reference generator. Then, we can create cross-references to the documentation for each particular variable from the manual text where this variable is mentioned.

@Moguri
Copy link
Collaborator

Moguri commented Jul 27, 2020

I am fine with not having the page in the manual proper, but I do reference this page a lot, so some form of replacement would be appreciated.

@rdb
Copy link
Member Author

rdb commented Jul 30, 2020

Yes, I think it should be automatically generated in the reference section. I don't intend to remove it before we have a replacement.

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