Skip to content

Update README.md#453

Open
kaitlin-beegle wants to merge 1 commit into0xPolygon:mainfrom
kaitlin-beegle:patch-1
Open

Update README.md#453
kaitlin-beegle wants to merge 1 commit into0xPolygon:mainfrom
kaitlin-beegle:patch-1

Conversation

@kaitlin-beegle
Copy link
Contributor

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

I'm looking through some PIPs but it's a bit burdensome to know what's where.

I added a table to the README- is this helpful for quickly browsing the repo? It's a bit of a manual process so I only wrote out the first 10 PIPs. If you like the change and merge, I'll add the rest.

Not sure if the table will make the README too long or bury PM info at the bottom? I considered writing a new doc to the repo with a table added, but that didn't seem like the best UX choice.

Fixes # (issue)

Easily review PIPs in repo from README, rather than navigating to each PIP document

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update
  • My edit follows the style guidelines

I'm looking through some PIPs, but it's a bit burdensome to know what's where. 

I added a table to the README- is this helpful for quickly browsing the repo? It's a bit of a manual process so I only wrote out the first 10 PIPs.  If you like the change and merge, I'll add the rest. 

Not sure if the table will make the README too long or bury PM info at the bottom? I considered writing a new doc to the repo with a table added, but that didn't seem like the best UX choice.
@hrook1
Copy link
Contributor

hrook1 commented Feb 27, 2025

This looks very useful. One of the functions of the governance hub was to provide this improved UX for interacting with PIPs.

I agree with your thoughts on burying the PM info, perhaps we could add this in the directory root and show it on the main page?

@kaitlin-beegle
Copy link
Contributor Author

This looks very useful. One of the functions of the governance hub was to provide this improved UX for interacting with PIPs.

I agree with your thoughts on burying the PM info, perhaps we could add this in the directory root and show it on the main page?

Sure! You mean for the table to be a separate file in the primary directory, instead of in the README, correct? I think that works! We'll just have to make sure we keep it current :)

Actually, if it's it's own file, we may be able to automate it every time certain PRs are merged...

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