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

Identity 1.0.0 - Diataxis + Code Examples - iteration 1 #1328

Merged
merged 9 commits into from
Nov 20, 2023

Conversation

lucas-tortora
Copy link
Collaborator

Description of change

  • applied diataxis - first iteration
  • switched to active voice where possible
  • split up some code examples
  • updated links
  • added redirects

Links to any relevant issues

fixes iotaledger/devx#295

Type of change

  • Documentation Enhancement

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own changes
  • I have made sure that added/changed links still work
  • I have commented my code, particularly in hard-to-understand areas

* switched to active voice where possible
* split up some code examples
* updated links
* added redirects
@lucas-tortora
Copy link
Collaborator Author

Copy link
Contributor

@jlvandenhout jlvandenhout left a comment

Choose a reason for hiding this comment

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

Awesome improvement to the docs. One general question: do we prefer capitalized Issuer, Verifiable Credential, etc., or lower case issuer, verifiable credential, etc.? I think we converged on the latter as they are not names but things, and it also reads more nicely for me.

lucas-tortora and others added 2 commits November 14, 2023 12:19
Co-authored-by: Jeroen van den Hout <[email protected]>
add npm to yarn
eike-hass
eike-hass previously approved these changes Nov 15, 2023
@Dr-Electron Dr-Electron dismissed stale reviews from eike-hass and themself via 3ad1e57 November 20, 2023 13:52
@Dr-Electron Dr-Electron removed the request for review from jlvandenhout November 20, 2023 14:03
@Dr-Electron Dr-Electron dismissed jlvandenhout’s stale review November 20, 2023 14:04

All changes requested where done

@Dr-Electron Dr-Electron merged commit ba3fe30 into main Nov 20, 2023
11 checks passed
@Dr-Electron Dr-Electron deleted the identity/diataxisAndOrganizeExamples branch November 20, 2023 14:05
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.

Organize Docs with Diataxis
4 participants