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

doc: Add unified docs for configuration autotools/CMake/manual builds #1372

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

hebasto
Copy link
Member

@hebasto hebasto commented Jul 4, 2023

Closes the last item in the "Affecting both build systems" group in #1235.

Draft for now, as it is based on #1291.

@sipa
Copy link
Contributor

sipa commented Jul 14, 2023

I'd prefer the documentation to have a single table with all configuration options, perhaps separated into sections, but not in separate tables. It's a bit chaotic now.

@real-or-random
Copy link
Contributor

Hm, I tend to think that I like the current layout, with the top-level sections being the different options (and not the build systems). It makes it easy to have larger description texts, e.g., the explanation of the window size.

But yeah, it's not very elegant when the tables all have different column widths (if this is what you dislike @sipa). In principle, it seems possible to set the column widths:

<table>
<tr><td width="500">foo</td><td>bar</td>
<table>

But that's hard to read as plain text, and it's deprecated HTML (GitHub doesn't like style="width:500px")... Not convinced.

@fanquake
Copy link
Member

fanquake commented Jul 1, 2024

Draft for now, as it is based on #1291.

If this is just docs, does it need to be based on #1291 (which seems to have stalled)?

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

Successfully merging this pull request may close these issues.

4 participants