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

docs: docusaurus/credentials refactor #1445

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mixmix
Copy link

@mixmix mixmix commented Nov 17, 2024

I'm preparing some docs for "connectionless" credentials. In trying to make space for them I noticed that this area in the docs was gonna get messy.

My solution (in preparation) was to refactor the docs (and assets) around credentials with 2 new patterns:

1. group credential path type

  • didcomm
  • oid4vc
  • connectionless (new, coming soon)

2. change asset naming to be explicit, and group

For format for file-names in these folders like <flow>.<implementation>.<file-extension>

new old
issue-flow.jwt.png issue-flow.png
issue-flow.anoncreds.png anoncreds-issue-flow.png

Here's what the workup looks like

├── credentials
│   ├── connectionless                          // << COMING SOON (placeholder)
│   │   ├── issue.md
│   │   └── present-proof.md
│   ├── didcomm
│   │   ├── anoncreds-setup.png                 // << unused?
│   │   ├── anoncreds-setup.puml
│   │   ├── issue-flow.anoncreds.png
│   │   ├── issue-flow.anoncreds.puml
│   │   ├── issue-flow.jwt.png
│   │   ├── issue-flow.jwt.puml
│   │   ├── issue.md
│   │   ├── present-proof-flow.anoncreds.png
│   │   ├── present-proof-flow.anoncreds.puml
│   │   ├── present-proof-flow.jwt.png
│   │   ├── present-proof-flow.jwt.puml
│   │   └── present-proof.md
│   ├── oid4cv
│   │   └── issue.md
│   └── revocation.md

@mixmix mixmix requested a review from a team as a code owner November 17, 2024 22:07
@mixmix mixmix changed the title group "credentials" by didcomm/oid4vc/connectionless docs/credentials refactor Nov 17, 2024
@mixmix mixmix changed the title docs/credentials refactor docss: docusaurus/credentials refactor Nov 17, 2024
@mixmix mixmix changed the title docss: docusaurus/credentials refactor docs: docusaurus/credentials refactor Nov 17, 2024
@mixmix
Copy link
Author

mixmix commented Nov 17, 2024

Question: not sure where anoncreds-setup.* should live...

@mixmix mixmix force-pushed the docs/refactor-credentials branch 2 times, most recently from 2ff26a3 to 830ff23 Compare November 18, 2024 01:46
Signed-off-by: mixmix <mix@protozoa.nz>
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.

1 participant