Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,9 @@

## Project Workflow

![Identity Workflow](docs/workflow.svg)
To understand the development process, contribution flow, and project structure, please refer to the detailed workflow guide:

The diagram above gives an overview of the identity token flow: self-issued identity minting, on-chain storage of identities, endorsements between holders, optional revocation, frontend interaction with chain data, and external verification by third-party services.

For more details, see [docs/workflow.md](docs/workflow.md).
👉 [View Workflow](docs/workflow.md)

---

Expand Down
88 changes: 79 additions & 9 deletions docs/workflow.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,87 @@
# Identity Tokens — Project Workflow
# 📘 WORKFLOWS

![Identity Workflow](./workflow.svg)
This document provides an overview of all major workflows in the system. Each section includes a brief explanation and a visual diagram to help you quickly understand how different parts of the platform interact.

## Overview
---

- **Self-issued identity token minting:** Users create and mint their own identity tokens, optionally attaching metadata. No central issuer is required.
## 🔗 Connect Wallet

- **On-chain identity storage:** Identity tokens and their metadata are stored on-chain (e.g. as ERC-721 NFTs), providing a portable, verifiable record.
This is the entry point for users. By connecting a wallet, users can securely interact with the platform, sign transactions, and access features like token creation and endorsements.

- **Endorsement by other identity holders:** Holders of identity tokens can endorse other identities on-chain, building a graph of attestations and trust.
<p align="center">
<img src="../public/assets/workflows/connect.png" width="600"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Add alt text to all workflow diagrams for accessibility compliance.

All eight workflow images are missing alt text, which prevents screen readers from describing these diagrams to visually impaired users. This is a WCAG accessibility violation that blocks users with visual disabilities from understanding the documented workflows.

♿ Proposed fix to add descriptive alt text
 <p align="center">
-  <img src="../public/assets/workflows/connect.png" width="600"/>
+  <img src="../public/assets/workflows/connect.png" alt="Workflow diagram showing wallet connection process" width="600"/>
 </p>

Apply similar descriptive alt text to all other images:

  • Line 22: alt="Workflow diagram for creating DIT token using the platform UI"
  • Line 32: alt="Workflow diagram for creating DIT token via direct smart contract interaction"
  • Line 42: alt="Internal flow diagram showing backend token creation process"
  • Line 52: alt="Workflow diagram for fetching token metadata using token URI"
  • Line 62: alt="Workflow diagram showing the endorsement process"
  • Line 72: alt="Workflow diagram showing the un-endorsement process"
  • Line 82: alt="Workflow diagram for auto-fetching metadata via token URI"

Also applies to: 22-22, 32-32, 42-42, 52-52, 62-62, 72-72, 82-82

🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 12-12: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/workflow.md` at line 12, The workflow images lack alt text; update each
<img src="../public/assets/workflows/connect.png" /> and the seven other
workflow <img> tags to include descriptive alt attributes as suggested (e.g.,
alt="Workflow diagram for creating DIT token using the platform UI",
alt="Workflow diagram for creating DIT token via direct smart contract
interaction", alt="Internal flow diagram showing backend token creation
process", alt="Workflow diagram for fetching token metadata using token URI",
alt="Workflow diagram showing the endorsement process", alt="Workflow diagram
showing the un-endorsement process", alt="Workflow diagram for auto-fetching
metadata via token URI") so screen readers can describe each diagram for
accessibility compliance.

</p>

- **Optional revocation:** Endorsements or credentials can support revocation (e.g. via a registry or expiry), so trust can be updated or withdrawn when needed.
---

- **Frontend reading on-chain data:** The frontend reads identity and endorsement data from the chain (e.g. via RPC and events) to display profiles, endorsements, and status.
## 🪙 Create DIT Token (Using Platform)

- **External services verifying identity:** Third-party services can verify identity and endorsements by reading the same on-chain data, enabling use cases like access control or credential checks without relying on the frontend alone.
Users can create a DIT token through a simple and guided UI. The platform handles contract interaction, metadata setup, and transaction flow, making it beginner-friendly.

<p align="center">
<img src="../public/assets/workflows/create-token.png" width="600"/>
</p>

---

## ⚙️ Create DIT Token (Without Platform)

This workflow is for advanced users who prefer direct interaction with smart contracts. It involves manually calling contract functions and handling parameters without the platform UI.

<p align="center">
<img src="../public/assets/workflows/create-token-N.png" width="600"/>
</p>

---

## 🔄 Internal Flow for Token Creation

This flow explains what happens behind the scenes when a token is created — including contract deployment/interactions, metadata linking, and backend processes (if any).

<p align="center">
<img src="../public/assets/workflows/Internal-flow-create.png" width="600"/>
</p>

---

## 📦 Fetch Token Metadata

This workflow shows how token metadata is retrieved using the token URI. It includes fetching details like title, description, and other attributes stored off-chain or on-chain.

<p align="center">
<img src="../public/assets/workflows/fetch-token-metadata.png" width="600"/>
</p>

---

## 👍 Endorsement Flow

Users can endorse a token to validate or support it. This process includes wallet confirmation, on-chain verification, and updating the endorsement state.

<p align="center">
<img src="../public/assets/workflows/endorsement-flow.png" width="600"/>
</p>

---

## 🔄 Un-Endorsement Flow

This flow allows users to remove their endorsement. It ensures proper validation and updates the blockchain state accordingly while maintaining data integrity.

<p align="center">
<img src="../public/assets/workflows/unEndorsement-flow.png" width="600"/>
</p>

---

## 🔍 Auto-fetch Metadata via Token URI

Wallets and applications can automatically fetch token metadata using the token URI. This improves usability by displaying token details without manual input.

<p align="center">
<img src="../public/assets/workflows/tokenUri.png" width="600"/>
</p>

---

> 💡 These workflows provide a clear understanding of how users and the system interact, covering both user-facing actions and internal processes.
Comment on lines +1 to +87

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Missing link to contract repository workflows as stated in PR objectives.

Issue #91 and the PR description specifically mention including a reference or link to the contract repository workflows to enable end-to-end understanding of the system. This deliverable appears to be missing from the updated documentation.

Consider adding a section (perhaps at the end or beginning) that links to the contract repository's workflow documentation for developers who need the complete picture.

📎 Suggested addition

Add a new section near the end of the document:

---

## 🔗 Related Resources

For a complete end-to-end understanding of the system, including smart contract workflows and backend processes, please refer to:

👉 [Contract Repository Workflows](https://github.com/StabilityNexus/IdentityTokens-EVM-Contracts/blob/main/docs/workflow.md)

---
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 12-12: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 22-22: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 32-32: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 42-42: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 52-52: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 62-62: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 72-72: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 82-82: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/workflow.md` around lines 1 - 87, Add a "Related Resources" section to
the WORKFLOWS document that links to the contract repository's workflow docs so
readers get end-to-end coverage; specifically, append a new section with a
separator and a heading like "🔗 Related Resources" and include a bullet/link to
the Contract Repository Workflows (the Contract Repository workflows URL from
Issue `#91` / PR description) so developers can navigate from the "WORKFLOWS" doc
to the contract workflows.

Binary file added public/assets/workflows/Internal-flow-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/assets/workflows/connect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/assets/workflows/create-token .png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/assets/workflows/create-token-N.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/assets/workflows/create-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/assets/workflows/endorsement-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/assets/workflows/fetch-token-metadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/assets/workflows/tokenUri.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/assets/workflows/unEndorsement-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading