Re: [PR] docs: comet docs design overhaul- phase 1 [datafusion-comet]

Wed, 27 May 2026 11:41:21 -0700 


pranamya123 commented on PR #4353:
URL: 
https://github.com/apache/datafusion-comet/pull/4353#issuecomment-4557563743

   > Seeing some inconsistencies with the terminal display : <img alt="image" 
width="853" height="424" 
src="https://private-user-images.githubusercontent.com/11091419/598528723-e5e9d5df-2b3b-459a-bffe-301585d06ac9.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Nzk5MDExMjQsIm5iZiI6MTc3OTkwMDgyNCwicGF0aCI6Ii8xMTA5MTQxOS81OTg1Mjg3MjMtZTVlOWQ1ZGYtMmIzYi00NTlhLWJmZmUtMzAxNTg1ZDA2YWM5LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA1MjclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNTI3VDE2NTM0NFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWExZmY0ZmY2MGQ0YzU2OGU0NTJiZDc1NzZjZWM2NmFlYTMzZjhjOGQwMzBmMmNmNzRiOGVhMDNjZTJjNjRhYWQmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRnBuZyJ9.wfryw8K4iEQ930-ioocWadxJe7mZjFx4Wvf5FqTlLTI";>
   > 
   > Seeing different sidebars :
   > 
   > PR :
   > 
   > <img alt="image" width="306" height="1048" 
src="https://private-user-images.githubusercontent.com/11091419/598529069-6eebba97-44dd-4105-9ac2-7da6afe2e043.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Nzk5MDExMjQsIm5iZiI6MTc3OTkwMDgyNCwicGF0aCI6Ii8xMTA5MTQxOS81OTg1MjkwNjktNmVlYmJhOTctNDRkZC00MTA1LTlhYzItN2RhNmFmZTJlMDQzLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA1MjclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNTI3VDE2NTM0NFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTUzY2M3M2Y5MjM5YmQyOGM0MTI5YjZiZTM4YjU4ZjljNmYwZWM5MmM0MWQzNmZiNDkxNjU1ODNkNWFjMzI5OTkmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRnBuZyJ9.P9vrXEbonQq8G23oLgnb1e31fUIupxfh9_3UWBNFbe8";>
   > Main :
   > 
   > <img alt="image" width="401" height="914" 
src="https://private-user-images.githubusercontent.com/11091419/598529130-57f1deb0-28ef-40d3-8f83-b96d79be24a8.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Nzk5MDExMjQsIm5iZiI6MTc3OTkwMDgyNCwicGF0aCI6Ii8xMTA5MTQxOS81OTg1MjkxMzAtNTdmMWRlYjAtMjhlZi00MGQzLThmODMtYjk2ZDc5YmUyNGE4LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA1MjclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNTI3VDE2NTM0NFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWM0ZDM3ODNmZTAyMjYwODNlZjBkZDg1NjM5N2VhY2ExZjE3Y2Q1OTMwNDcxOTg2MGMwMmU0YzI5NTBmODAyMjkmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRnBuZyJ9.wMlpEg5h00nPyzGixfczRZE1k4CB9HR_UKXZUhU4cGg";>
   > Also missing important config:
   > 
   > PR :
   > 
   > <img alt="image" width="957" height="857" 
src="https://private-user-images.githubusercontent.com/11091419/598529352-75570d40-e07b-4ea1-ae97-7692e3b78765.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Nzk5MDExMjQsIm5iZiI6MTc3OTkwMDgyNCwicGF0aCI6Ii8xMTA5MTQxOS81OTg1MjkzNTItNzU1NzBkNDAtZTA3Yi00ZWExLWFlOTctNzY5MmUzYjc4NzY1LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA1MjclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNTI3VDE2NTM0NFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTgxYjU2OTg2YjVhNTg4ZmNhNWQ2YzMyMzZmN2RhNDcwYWNlZDhhYjY1YTVlZDA5ZDM2MWQwMjkyOGM5YWE3YTkmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRnBuZyJ9.cMxQ4glYEudgNkvWGMeP-f4Kk0lwagpvRYdNFihzZ3k";>
   > Main :
   > 
   > <img alt="image" width="1063" height="698" 
src="https://private-user-images.githubusercontent.com/11091419/598529260-059bce08-dbe3-43eb-97e9-12c332c00e9f.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Nzk5MDExMjQsIm5iZiI6MTc3OTkwMDgyNCwicGF0aCI6Ii8xMTA5MTQxOS81OTg1MjkyNjAtMDU5YmNlMDgtZGJlMy00M2ViLTk3ZTktMTJjMzMyYzAwZTlmLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA1MjclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNTI3VDE2NTM0NFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTE1OWUwNzJhMjE5OTBmNWE2ZDU1YWI0MjVhNWRjMmJjNDU4NTM3YmE5YWFjMTA5MWVhYmExN2U1MDMyMzAxZmUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRnBuZyJ9.BOdLsEzKpdrT8UDVoeMptVv0Co0skqiC4AUZu4a_UEI";>
   > Seeing issues with the expression data as well :
   > 
   > <img alt="image" width="1131" height="932" 
src="https://private-user-images.githubusercontent.com/11091419/598529592-9fd66c7a-6d4b-4645-91a0-0b71a3133a89.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Nzk5MDExMjQsIm5iZiI6MTc3OTkwMDgyNCwicGF0aCI6Ii8xMTA5MTQxOS81OTg1Mjk1OTItOWZkNjZjN2EtNmQ0Yi00NjQ1LTkxYTAtMGI3MWEzMTMzYTg5LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA1MjclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNTI3VDE2NTM0NFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTkyZmIyMzdmNmYzMWFiZGMwNzg1ZjAxNjNkZjA3NTZiZmE5ZDc2NjJlYWY4YTAwNzcxNWY3YzZlN2E5Y2EzMTUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRnBuZyJ9.plyDBu1M816HO0fmO_TD1XnocR_PJU3QSFZa2l1uGsM";>
 <img alt="image" width="881" height="303" 
src="https://private-user-images.githubusercontent.com/11091419/598529662-572
 
cc4ab-5b0d-4fc8-98ae-73ad79ac254a.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Nzk5MDExMjQsIm5iZiI6MTc3OTkwMDgyNCwicGF0aCI6Ii8xMTA5MTQxOS81OTg1Mjk2NjItNTcyY2M0YWItNWIwZC00ZmM4LTk4YWUtNzNhZDc5YWMyNTRhLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA1MjclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNTI3VDE2NTM0NFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTg2OTc4YzlmZmVhODM5YTQ1OTIxYTM0YjNhN2Q5YzFmMWExYTExOWQ4ZDA2Yjk0MDQyZGNmOGMzNjkxYzhhZWImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRnBuZyJ9.SHFtXlSjE_szIqxbIvJTtKlNVBnqY2hM0ULm94w-G2E">
   > Could we please confirm that the text / content is not missing ?
   
   Thanks @coderfender — confirming no content is missing. What you're 
   seeing is the Netlify preview running only `sphinx-build`, while 
   production runs the full `docs/build.sh` which has two extra steps that 
   populate this content:
   
   1. Terminal display inconsistencies: Could you point me at the page that has 
this specific issue, so that I can reproduce the issue?
   
   2. sidebar difference vs main: this is intentional. The current template 
(inherited from main) uses `startdepth=2` for `/user-guide/latest/*` pages 
only, which swaps the entire sidebar to the snapshot's internal captioned 
subgroups (`GETTING STARTED`, `WHAT COMET SUPPORTS`, etc.) the moment you click 
into a Dev Snapshot child page. So navigating from the User Guide landing into 
"Installing Comet" makes the version groups disappear and replaces them with a 
totally different tree — that's the disorienting behavior you reported earlier 
in the review.
   
   With a fixed `startdepth=1`, the same three groups stay visible across every 
User Guide page; only the `.current` highlight moves.
   
   I took a UX judgement call here — the user would expect to stay anchored on 
the Development Snapshot sidebar item with its child items opened under it, 
instead of having the whole sidebar replaced and feeling like they navigated to 
a different site.
   
   That said, if the team prefers main's switching behavior over the 
consistent-tree approach, happy to revert.
   
   3&4. Config tables on `configs.md` and the 10 expression compatibility 
pages: these use `<!--BEGIN:CONFIG_TABLE[...]-->` and 
`<!--BEGIN:EXPR_COMPAT[...]-->` markers that get filled in by `./mvnw 
-Pgenerate-docs`, which reads the Spark/Comet source annotations at build time. 
Sphinx alone doesn't run this, so the markers stay empty on the preview.
   
   I tried running the Maven step locally to verify it too, but hit a separate 
build issue (proto-generated classes not on the spark module's classpath — 
reproduces on a clean `main` checkout, not introduced by this PR). The Apache 
CI environment doesn't hit that, so these tables will populate normally once 
this PR merges.
   
   This PR doesn't touch either build step, the visual styling layers on top of 
whatever content the pipeline produces.
   
   
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to