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

documentation: define user journey sequence diagram #9

Open
machuwey opened this issue Nov 9, 2024 · 7 comments
Open

documentation: define user journey sequence diagram #9

machuwey opened this issue Nov 9, 2024 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@machuwey
Copy link
Collaborator

machuwey commented Nov 9, 2024

Define in the README.md the squence diagram of the user-system journey during a checkout:

Some of the key components should be the user, the contract, the backend and the frontend and the indexers and specify how they interact between each other.

@machuwey machuwey added the documentation Improvements or additions to documentation label Nov 9, 2024
@martinvibes
Copy link

hey @machuwey would like to work on this when the odhack starts :)

@Jemiiah
Copy link

Jemiiah commented Nov 18, 2024

Can I work on this issue @machuwey

@Michaelkingsdev
Copy link

i am good at writing documentation. I can easily work on this issue.

@petersdt
Copy link

@machuwey can i be assigned this issue. I have experience in technical writing and have contributed to documenting some project through the odhack platform. kindly assign me . ETA <=24hrs

@od-hunter
Copy link

Hi @machuwey , can I be assigned this please? I am a blockchain developer and I'm also good at documentations.
In my documention in the README.md, I'll define the squence diagram of the user-system journey during a checkout. I'll add key components as the user, the contract, the backend and the frontend and the indexers and specify how they interact between each other.
Below are some of the documentations I've done that were merged:
dojoengine/book#308,
keep-starknet-strange/joyboy#143,
Scaffold-Stark/ss2-docs#31,
horuslabsio/Starknet-Scaffold#94,
Hyle-org/examples#15.

Please I’m ready to work, assign me please.

@NueloSE
Copy link

NueloSE commented Nov 22, 2024

@machuwey i would like to contribute to this project. kindly assign me this

@Judah04
Copy link

Judah04 commented Nov 22, 2024

Hi @machuwey
I wanna work on this. I would define the user journey sequence diagram in the README.md using Mermaid and ensure the interactions between the user, frontend, backend, contract, and indexers are outlined.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

8 participants