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.

Sign up for GitHub

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

Jump to bottom

Add Windows-Compatible Curl Commands to SSI Documentation #1005

Closed
blackgirlbytes opened this issue Nov 15, 2023 · 6 comments
Closed

Add Windows-Compatible Curl Commands to SSI Documentation #1005

blackgirlbytes opened this issue Nov 15, 2023 · 6 comments
Assignees
@angiejones @blackgirlbytes @samejima-san @EbonyLouis
Labels
documentation Improvements or additions to documentation site-feedback Feedback from developer.tbd.website

Comments

@blackgirlbytes
Copy link
Contributor

Type

Content Issue

Feedback

Our current documentation provides curl command examples that are compatible with Mac/Linux environments. However, I realized these commands do not work as intended on Windows after helping Hackathon participants who were struggling to run curl commands in our documentation.

This happens because Mac/Linux uses single quotes ('), but Windows uses double quotes (")

Ex:
Works for Mac

curl -X PUT localhost:8080/v1/dids/key -d '{"keyType":"Ed25519"}'

Works for Windows

curl -X PUT localhost:8080/v1/dids/key -d "{\"keyType\":\"Ed25519\"}"

Pages that need to be updated:

Screenshots

Paste relevant images or screenshots here
Screenshot 2023-11-15 at 1 19 42 PM

developer.tbd.website URL

No response

Browser

No response

Relevant log output

No response
@blackgirlbytes blackgirlbytes added site-feedback Feedback from developer.tbd.website triage Issues needing response or filing labels Nov 15, 2023
@blackgirlbytes blackgirlbytes mentioned this issue Nov 22, 2023
Closed
@samejima-san
Copy link
Contributor

here for the assignment!

@blackgirlbytes blackgirlbytes added documentation Improvements or additions to documentation and removed triage Issues needing response or filing labels Nov 22, 2023
@blackgirlbytes
Copy link
Contributor Author

blackgirlbytes commented Nov 22, 2023 •
edited
Loading

Here's my idea of how to approach this..You can create tabs which will switch between Mac and Windows commands to look like this:

Screen.Recording.2023-11-22.at.10.50.12.AM.2.mov

You can do something like this:

---
sidebar_position: 3
title: Create a DID
hide_title: true
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Create a Decentralized Identifier (DID)

In the world of SSI, [DIDs](/docs/web5/learn/decentralized-identifiers) are used to identify any subject (e.g., a person, organization, thing, data model, abstract entity, etc.). In this tutorial we'll show you how to create a DID using the [SSI Service](https://github.com/TBD54566975/ssi-service). 

:::info
## Prerequisites

Follow guide to [Clone & Run SSI Service](run-ssi-service).
:::

## Create DID

To create your DID, run the following request:

<Tabs
  defaultValue="mac"
  values={[
    { label: 'Mac', value: 'mac', },
    { label: 'Windows', value: 'windows', },
  ]}>
  <TabItem value="mac">



curl -X PUT localhost:8080/v1/dids/key -d '{"keyType":"Ed25519"}'


</TabItem>
<TabItem value="windows">

curl -X PUT localhost:8080/v1/dids/key -d "{\"keyType\":\"Ed25519\"}"

</TabItem>
</Tabs>

@blackgirlbytes
Copy link
Contributor Author

Also you can probably turn the Tabs component into a reusable component in our application where you just have to pass in the Windows curl command and Mac curl commands as props

@samejima-san samejima-san mentioned this issue Nov 25, 2023
Closed
20 tasks
@angiejones angiejones self-assigned this Jan 2, 2024
@ALRubinger
Copy link
Contributor

@blackgirlbytes Would you mind an update or close here if no longer valid?

@angiejones
Copy link
Member

PR here. Needs to be refactored to use the newer Shnip structure

@blackgirlbytes
Copy link
Contributor Author

SSI documentation was removed, so I'm closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@angiejones angiejones

@blackgirlbytes blackgirlbytes

@samejima-san samejima-san

@EbonyLouis EbonyLouis

Labels
documentation Improvements or additions to documentation site-feedback Feedback from developer.tbd.website
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

adds support for windows in documentation samejima-san/developer.tbd.website
5 participants
@ALRubinger @angiejones @blackgirlbytes @samejima-san @EbonyLouis