Skip to content

Commit

Permalink
Apply diataxis to Identity 1.0.0 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lucas-tortora authored Nov 20, 2023
1 parent 7194cd8 commit ba3fe30
Show file tree
Hide file tree
Showing 43 changed files with 1,605 additions and 1,248 deletions.
100 changes: 100 additions & 0 deletions articleRedirects.js
Original file line number Diff line number Diff line change
Expand Up @@ -542,4 +542,104 @@ exports.articleRedirects = [
from: '/use/wallets/what-is-a-wallet',
to: '/get-started/wallets/firefly',
},
{
from: '/identity.rs/concepts/decentralized_identifiers/alias/',
to: '/identity.rs/explanations/about-alias-outputs/',
},
{
from: '/identity.rs/concepts/decentralized_identifiers/create/',
to: '/identity.rs/how-tos/decentralized-identifiers/create/',
},
{
from: '/identity.rs/concepts/decentralized_identifiers/delete/',
to: '/identity.rs/how-tos/decentralized-identifiers/delete/',
},
{
from: '/identity.rs/concepts/decentralized_identifiers/overview/',
to: '/identity.rs/explanations/decentralized-identifiers/',
},
{
from: '/identity.rs/concepts/decentralized_identifiers/resolve/',
to: '/identity.rs/how-tos/decentralized-identifiers/resolve/',
},
{
from: '/identity.rs/concepts/decentralized_identifiers/update/',
to: '/identity.rs/how-tos/decentralized-identifiers/update/',
},
{
from: '/identity.rs/concepts/domain_linkage/',
to: '/identity.rs/how-tos/domain-linkage/create-and-verify/',
},
{
from: '/identity.rs/concepts/key_storage/',
to: '/identity.rs/how-tos/key-storage/',
},
{
from: '/identity.rs/concepts/verifiable_credentials/create/',
to: '/identity.rs/how-tos/verifiable-credentials/create/',
},
{
from: '/identity.rs/concepts/verifiable_credentials/overview/',
to: '/identity.rs/explanations/verifiable-credentials/',
},
{
from: '/identity.rs/concepts/verifiable_credentials/revocation/',
to: '/identity.rs/how-tos/verifiable-credentials/revocation/',
},
{
from: '/identity.rs/concepts/verifiable_credentials/verifiable_presentations/',
to: '/identity.rs/explanations/verifiable-presentations/',
},
{
from: '/identity.rs/decentralized_identity/',
to: '/identity.rs/explanations/decentralized-identifiers/',
},
{
from: '/identity.rs/getting_started/create_and_publish/',
to: '/identity.rs/how-tos/decentralized-identifiers/create/',
},
{
from: '/identity.rs/getting_started/install/',
to: '/identity.rs/getting-started/rust/',
},
{
from: '/identity.rs/getting_started/overview/',
to: '/identity.rs/getting-started/rust/',
},
{
from: '/identity.rs/introduction/',
to: '/identity.rs/welcome/',
},
{
from: '/identity.rs/libraries/overview/',
to: '/identity.rs/welcome/',
},
{
from: '/identity.rs/libraries/rust/getting_started/',
to: '/identity.rs/getting-started/rust/',
},
{
from: '/identity.rs/libraries/wasm/api_reference/',
to: '/identity.rs/references/api/wasm/',
},
{
from: '/identity.rs/libraries/wasm/getting_started/',
to: '/identity.rs/getting-started/wasm/',
},
{
from: '/identity.rs/specs/did/iota_did_method_spec/',
to: '/identity.rs/references/specifications/iota-did-method-spec/',
},
{
from: '/identity.rs/specs/did/overview/',
to: '/identity.rs/references/specifications/overview/',
},
{
from: '/identity.rs/specs/overview/',
to: '/identity.rs/references/specifications/overview/',
},
{
from: '/identity.rs/specs/revocation_bitmap_2022/',
to: '/identity.rs/references/specifications/revocation-bitmap-2022/',
},
];
2 changes: 1 addition & 1 deletion banners/identity-deprecated.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
This version of IOTA Identity is deprecated. Please upgrade to [Identity 0.6 for Chrysalis Networks](/identity.rs/introduction/) and follow the migration instructions for upgrading Stronghold Snapshot files [here](/identity.rs/tutorials/migrate-stronghold/), or upgrade to the latest version of [IOTA Identity for Stardust Networks](/identity.rs/0.7/introduction/).
This version of IOTA Identity is deprecated. Please upgrade to [Identity 0.6 for Chrysalis Networks](/identity.rs/welcome/) and follow the migration instructions for upgrading Stronghold Snapshot files [here](/identity.rs/tutorials/migrate-stronghold/), or upgrade to the latest version of [IOTA Identity for Stardust Networks](/identity.rs/0.7/introduction/).
4 changes: 2 additions & 2 deletions docs/build/getting-started/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ tokens and NFTs, and more.

### Identity

You can use the [IOTA Identity Framework](/identity.rs/introduction) to create and manage
[Self-Sovereign Identities (SSI)](/identity.rs/decentralized_identity) for people, organizations, or
You can use the [IOTA Identity Framework](/identity.rs/welcome) to create and manage
[Self-Sovereign Identities (SSI)](/identity.rs/explanations/decentralized-identifiers) for people, organizations, or
any object in a GDPR-compliant, cost-efficient, and privacy-enabling manner.

## Layer 2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ keywords:

> This is the beta version of the official WASM bindings for [IOTA Identity](https://github.com/iotaledger/identity.rs).
## [API Reference](/identity.rs/libraries/wasm/api_reference)
## [API Reference](./api_reference.mdx)

## [Account Examples](https://github.com/iotaledger/identity.rs/blob/support/v0.6/bindings/wasm/examples-account/README.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ npm run start create-did alice alice-password
This will create a minimal DID document for alice, and publish it to the Tangle. A Stronghold file `alice.hodl` will be created under `/stronghold-files` which contains the Account's state and the private key of the main verification method of the DID.
`alice-password` will be used as a password for the stronghold storage. Obviously this password must be more secure in production applications.

See [Creating a Decentralized Identity](/identity.rs/concepts/decentralized_identifiers/create) for more information about generating DIDs.
See [Creating a Decentralized Identity](../concepts/decentralized_identifiers/create.mdx) for more information about generating DIDs.

### 2. **Issuer**: Create a DID

Expand All @@ -94,7 +94,7 @@ with that `uni-of-oslo.hodl` will be created under `/stronhold-files`.
### 3. **Issuer**: Add a Verification Method

Since the university will need to issue a signed verifiable credential for Alice, a verification method should be added to the university's DID document.
Read more about adding verification methods in [update DID Documents](/identity.rs/concepts/decentralized_identifiers/update).
Read more about adding verification methods in [update DID Documents](../concepts/decentralized_identifiers/update.mdx).

To add a Verification Method the following command can be used:

Expand Down Expand Up @@ -123,7 +123,7 @@ npm run start create-vm alice alice-password key-1

### 5: **Issuer**: Create Revocation list

In order for the issuer to be able to revoke credentials in the future, a revocation list is needed. See [Verifiable Credential Revocation](/identity.rs/concepts/verifiable_credentials/revocation) for further details.
In order for the issuer to be able to revoke credentials in the future, a revocation list is needed. See [Verifiable Credential Revocation](../concepts/verifiable_credentials/revocation.mdx) for further details.
The following command can be used to create a revocation list:

```bash
Expand Down

This file was deleted.

This file was deleted.

Loading

0 comments on commit ba3fe30

Please sign in to comment.