Skip to content

gh-157525: Docs: align documentation homepage layout and chapter order - #157528

Open
m-aciek wants to merge 2 commits into
python:mainfrom
m-aciek:contentstable-flex-layout
Open

m-aciek wants to merge 2 commits into
python:mainfrom
m-aciek:contentstable-flex-layout

Conversation

@m-aciek

@m-aciek m-aciek commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Closes #157525.

Replace the documentation homepage’s two independent columns with a single list that flows across rows on wider screens and stacks vertically on smaller screens. Related sections appear next to each other on desktop and consecutively on mobile.

Reorder the root table of contents to match the homepage, so chapter navigation follows the same sequence.

Suggestions on the section order are welcome. The aim is to keep related topics together while maintaining a consistent reading order across layouts and chapter navigation.

Desktop: before and after

Before:

docs python org-3 16

After:

localhost-cpython-build-html-index html
Mobile: before and after
Before After
docs python org-3 16-narrow localhost-cpython-build-html-index html-narrow

@chatgpt-codex-connector

This comment was marked as resolved.

@m-aciek m-aciek added this to Docs PRs Sep 14, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Sep 14, 2026
@m-aciek m-aciek added the docs Documentation in the Doc dir label Sep 14, 2026
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34558090 | 📁 Comparing 40eaa33 against main (e5fbabb)

  🔍 Preview build  

1 file changed
± index.html

@hugovk

hugovk commented Sep 15, 2026

Copy link
Copy Markdown
Member

Looking at the desktop before and after, I think I prefer the before:

I usually read down the columns, as they're closer to each other, and not row-by-row, so find it more useful to have the 3 x reference next to each other in a column.

@nedbat

nedbat commented Sep 15, 2026

Copy link
Copy Markdown
Member

TBH, I prefer the new row-by-row, but only slightly. Any order in a 2-by-X table is going to be an odd way to present what is conceptually a single list, but row-by-row means the two items at the top of the page are the first two items.

@m-aciek

m-aciek commented Sep 15, 2026

Copy link
Copy Markdown
Contributor Author

I investigated a conservative approach — keeping the current display order and adjusting contents.rst accordingly — but that would interweave the different chapter types in contents.rst.

@m-aciek

m-aciek commented Sep 15, 2026

Copy link
Copy Markdown
Contributor Author

Let me create an alternative draft PR with flow by columns for preview.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

Docs: align homepage reading order with chapter navigation

3 participants