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

Update README.md #1228

Merged
merged 3 commits into from
Nov 8, 2024
Merged

Update README.md #1228

merged 3 commits into from
Nov 8, 2024

Conversation

Saira-A
Copy link
Contributor

@Saira-A Saira-A commented Nov 8, 2024

Issue #1203 - just the governance doc for now but will add more as we get them.
Also put the 'scope' section back as it had been commented out but the anchor was still there.

Copy link

vercel bot commented Nov 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
universalviewer ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 8, 2024 2:25pm

@LanieOkorodudu
Copy link
Collaborator

LanieOkorodudu commented Nov 8, 2024

@Saira-A This looks good to me. Let’s wait for @demiankatz feedback on the README update to see what he thinks.

@demiankatz
Copy link
Contributor

@Saira-A and @LanieOkorodudu, I like the governance link you've added!

I see that you've also uncommented the Scope section. I'm not sure why that was commented out in the first place (the Git history is unfortunately not enlightening). I honestly don't really like the "Scope" heading -- not sure what it really means; I would be more inclined to call this "About" or "Project History" if it needs a heading. But more than that, I wonder if we should delete the heading entirely and just move the "about the project" link to some other section. I don't think it's the first thing most people are going to want to read about, so having it take up so much real estate so early in the document seems unhelpful.

@Saira-A
Copy link
Contributor Author

Saira-A commented Nov 8, 2024

@Saira-A and @LanieOkorodudu, I like the governance link you've added!

I see that you've also uncommented the Scope section. I'm not sure why that was commented out in the first place (the Git history is unfortunately not enlightening). I honestly don't really like the "Scope" heading -- not sure what it really means; I would be more inclined to call this "About" or "Project History" if it needs a heading. But more than that, I wonder if we should delete the heading entirely and just move the "about the project" link to some other section. I don't think it's the first thing most people are going to want to read about, so having it take up so much real estate so early in the document seems unhelpful.

Thanks! I agree - I just put it back since the anchor link for it was still there but leading to nothing. Since the about section is part of the Wiki I could just link to that instead, perhaps at the top next to the Slack/Twitter links?

@demiankatz
Copy link
Contributor

Sounds like a good plan, @Saira-A -- I agree that it makes sense to just remove the scope link from the nav menu (which was probably only left there as an oversight) and add an about link at the top where you suggest.

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@demiankatz demiankatz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now. Thanks again!

@demiankatz
Copy link
Contributor

(We can merge at the meeting in 30 minutes if nobody else objects to anything).

@LanieOkorodudu
Copy link
Collaborator

(We can merge at the meeting in 30 minutes if nobody else objects to anything).

thanks @demiankatz

@demiankatz demiankatz merged commit 6241973 into dev Nov 8, 2024
3 checks passed
@demiankatz demiankatz deleted the Saira-A-readme-1 branch November 8, 2024 15:13
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.

3 participants