docs: investigation on display names #66
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mmrj
commented
May 3, 2024
| "cpp-server-sdk": "C++ Server SDK", | ||
| "dotnet-client-sdk": ".NET Client SDK", | ||
| "dotnet-server-sdk": ".NET Server SDK", | ||
| "cpp-client-sdk": "C++ (client-side) SDK", |
There was a problem hiding this comment.
The linter error makes is sound like () are not allowed in this string?
There was a problem hiding this comment.
I can fix this in another PR
ember-stevens
approved these changes
May 6, 2024
|
What we can do here is use this as a spec to update the individual repos (as this file is generated daily from the repos.) While we're at it, I'm wondering if we should update the READMEs to be consistent as well? For example:
I can see those being more of a description than the name of the SDK in the last two cases |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SC-242572
These changes would bring the current display names (used, for example, here) up-to-date with how we otherwise refer to each SDK in the product docs:
(client-side)or(server-side)Let me know what you recommend as next steps here -- happy to update the names in individual SDK repos, or have this PR be used as a spec to programmatically update the existing names in the
ld-docs-privaterepo'sEndOfLifemethod.