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

Add shortcuts to SDKs and allow query parameters #225

Merged
merged 3 commits into from
Dec 15, 2023
Merged

Conversation

gvdongen
Copy link
Contributor

@gvdongen gvdongen commented Dec 15, 2023

Fixes #226

  • Adds shortcuts to Java and TS SDK in header
  • Allows query parameters to open docs for specific languague without having to select the tab anymore

Copy link

cloudflare-workers-and-pages bot commented Dec 15, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5ff765d
Status: ✅  Deploy successful!
Preview URL: https://60544830.documentation-beg.pages.dev
Branch Preview URL: https://add-shortcuts.documentation-beg.pages.dev

View logs

@gvdongen gvdongen marked this pull request as ready for review December 15, 2023 12:20
Copy link
Contributor

@pcholakov pcholakov left a comment

Choose a reason for hiding this comment

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

Nice!

@@ -88,6 +88,16 @@ const config = {
target: "_self",
},
items: [
{
href: "/services/sdk/overview?sdk=ts",
label: "Typescript SDK",
Copy link
Contributor

Choose a reason for hiding this comment

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

Nitpick – we have somewhat inconsistent capitalisation of TypeScript; I believe the canonical spelling is with a capital S :-)

Suggested change
label: "Typescript SDK",
label: "TypeScript SDK",

Copy link
Contributor

Choose a reason for hiding this comment

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

Also: should we refer to this as the TypeScript / JavaScript SDK? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh you're right. I'll adapt that everywhere... Maybe in a separate PR to avoid overflowing this one.

},
{
to: "/services/sdk/overview?sdk=java",
label: "Java SDK",
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto "Java / Kotlin SDK"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added an issue for writing Kotlin docs in general: #227
We can take this approach where it's similar for both. But for example, the example on the overview page will look different.

@gvdongen gvdongen merged commit 046c276 into main Dec 15, 2023
3 checks passed
@gvdongen gvdongen deleted the add_shortcuts branch December 15, 2023 12:44
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.

Add shortcuts to SDKs on top of docs page
2 participants