Skip to content

Cleaned up the README (nits)#768

Open
alxmrs wants to merge 1 commit into
mainfrom
u/alxmrs/readme-eng
Open

Cleaned up the README (nits)#768
alxmrs wants to merge 1 commit into
mainfrom
u/alxmrs/readme-eng

Conversation

@alxmrs

@alxmrs alxmrs commented Jun 18, 2026

Copy link
Copy Markdown
Member

I think this improves the flow.

I think this improves the flow.
@alxmrs alxmrs requested review from YuanYuan98 and jder June 18, 2026 19:22
@jder

jder commented Jun 18, 2026

Copy link
Copy Markdown
Member

How about putting the images before any of the text after the badges? I would guess no one will ever find the last line of text with this image immediately before it.

@alxmrs

alxmrs commented Jun 18, 2026

Copy link
Copy Markdown
Member Author

I find that the image placement has the opposite effect, that I'm more likely to skim over the gif and then see the call to action right below it. I like how the image breaks up the descriptions of Samudra vs the call-to-action section. WDYT? Here's a screenshot:

Screenshot 2026-06-18 at 2 30 41 PM

@jder

jder commented Jun 18, 2026

Copy link
Copy Markdown
Member

I don't have the same intuition but I also don't think it matters very much.

@alxmrs

alxmrs commented Jun 18, 2026

Copy link
Copy Markdown
Member Author

Thanks! In general, I'd love to get input from the team / other OA folks / Sophie to discuss how we could make our README more presentable.

@alxmrs alxmrs enabled auto-merge (squash) June 18, 2026 21:53
@jder

jder commented Jun 18, 2026

Copy link
Copy Markdown
Member

Yeah, this was just my attempt to have there be some content; definitely agreed we should improve it.

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

Successfully merging this pull request may close these issues.

2 participants