Update README.md to include pinned repos #11
Conversation
| [](https://github.com/temporalio/sdk-dotnet) | ||
| [](https://github.com/temporalio/sdk-ruby) | ||
|
|
||
|
|
There was a problem hiding this comment.
Since we're not constrained now, might be cool to show Core here as well
There was a problem hiding this comment.
I considered that, but decided not to include it in my PR because it wasn't like the others (i.e., mainly of interest to SDK developers instead of application developers and the prototype Rust SDK it contains is considered pre-alpha). You're the authority here, though, and if you'd like to include it then it seems reasonable to me. Since that would add a new row, it also allows me to include the PHP SDK without the table becoming symmetrical.
There was a problem hiding this comment.
Oh yeah I didn't even realize PHP wasn't there. I think we definitely want to include it. It's an official SDK just like the others.
And yeah, your point about Core makes perfect sense. I'll admit I have some incentive for people to see it and increase demand for us to actually productionize the Rust SDK :). Adding it to fill in the symmetry with PHP seems nice though.
There was a problem hiding this comment.
Agreed on PHP. Similarly on the fence about Core just because I'm not sure we want to encourage its direct use.
There was a problem hiding this comment.
I committed a change to implement better handling of light mode/dark mode, but it also added a new row that includes the PHP and Core SDKs. You can be the judge as to whether that's a path towards graduating the Rust SDK from the prototype stage or just a way to make the boxes symmetrical.
| )](https://x.com/temporalio) | ||
| [](https://x.com/temporalio) | ||
|
|
||
| ## Pinned |
There was a problem hiding this comment.
Not sure we need to call these "Pinned", I think maybe a server and CLI section w/ those two and then an SDK section with the rest. Could even have SDK on left with its sample repo on the right, but up to you. I don't have a strong opinion, so am OK with "Pinned" too.
There was a problem hiding this comment.
I went with "Pinned" to minimize change from what's there now. Like you, I don't have a strong opinion on it, though.
IMHO adding the sample repo next to each SDK repo would result in too many cards (i.e., would make the page too busy). I think that could work well in a table format, though, and could include a link to the developer guide and API documentation. For example:
| SDK | Samples | Developer Guide | API Reference |
|---|---|---|---|
| sdk-go | samples-go | Go Developer Guide | Go SDK API |
| sdk-java | samples-java | Java Developer Guide | Java SDK API |
profile/README.md
Outdated
| [](https://x.com/temporalio) | ||
|
|
||
| ## Pinned | ||
| [](https://github.com/temporalio/temporal) |
There was a problem hiding this comment.
Hrmm here's how transparent looks on dark mode today:
Compare with the default pins:
I wonder https://github.com/anuraghazra/github-readme-stats?tab=readme-ov-file#use-githubs-theme-context-tag + github_dark theme may be better for dark, e.g. (and leave default theme for light)
There was a problem hiding this comment.
Unfortunately, there is no theme that automatically switches from dark to light based on the user's preferences. You have to duplicate each item and use an anchor to hide one or the other based on whether the user has dark mode or light mode enabled. It makes the code uglier and more prone to mistakes, but for as seldom as we'd update it, that is probably OK.
I committed a change to implement this. I also added two new cards, one for the PHP SDK and one for the Core SDK, as per Spencer's suggestion.
What was changed
I added a "Pinned" section to the README.
In an unrelated change, I capitalized "Durable Execution" (as per our convention) and changed "system" to "platform" to reflect our messaging.
Why?
GitHub limits organizations to a maximum of six pinned repositories. Since we have already reached this limit, we can't pin the new Ruby SDK. At Chad's suggestion, I used a third-party project that allows us to include cards in our README that provides a similar look-and-feel to pinned repositories. This PR uses those, adding a new "Pinned" section that includes the existing six pinned repositories plus the Temporal CLI and the Ruby SDK.
NOTE: Please allow me to handle the merge, since I will need to coordinate that with unpinning the six repositories that are currently pinned (otherwise they will duplicate what's included here).
Checklist
I tested this in Safari, Firefox, and Google Chrome. In Safari, I alternated between enabling light mode and dark mode my GitHub account preferences.