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.

Sign up for GitHub

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

Jump to bottom

docs: add tutorial to docs #605

Merged
merged 20 commits into from
Nov 29, 2024
Merged

docs: add tutorial to docs #605

merged 20 commits into from
Nov 29, 2024

Conversation

waddaboo
Copy link
Contributor

@waddaboo waddaboo commented Nov 22, 2024 •
edited
Loading

Description

This PR implements a new section Tutorial to the Bandada documentation.

The idea is to guide users through the process of creating a group and managing group members using the Bandada Dashboard, and to improve the user experience.

Related Issue

Closes #603

Does this introduce a breaking change?

  • Yes
  • No

Other information

@waddaboo waddaboo requested a review from vplasencia November 22, 2024 13:51
@vercel Vercel
Copy link

vercel bot commented Nov 22, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bandada-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 29, 2024 4:04pm
bandada-website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 29, 2024 4:04pm

vplasencia
vplasencia reviewed Nov 24, 2024
View reviewed changes
Copy link
Member

@vplasencia vplasencia left a comment

Choose a reason for hiding this comment

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

Hey! Great work! Thank you.

What about adding code (using the API SDK) to show how to create groups and add (remove) members. Mainly for credentials groups, as it's harder to figure out how to do that.

If the page gets longer, I think it's better to have a section called Tutorials and have a page for the log in tutorial, another page for creating and managing off-chain groups, another for the credential groups and another for the on-chain groups. Something like the Guides or Technical reference sections in the Semaphore docs. This way people can go to the tutorial they need. What do you think?

@waddaboo waddaboo requested a review from vplasencia November 26, 2024 11:45
@waddaboo
Copy link
Contributor Author

Oh I realized I have yet to add in add and remove members from credential groups using API SDK. Will tag you once I have added those in.

Converting this PR to draft.

@waddaboo waddaboo marked this pull request as draft November 26, 2024 11:50
@waddaboo waddaboo marked this pull request as ready for review November 27, 2024 07:22
@waddaboo
Copy link
Contributor Author

@vplasencia Hey! I have updated the documentation. Feel free to review it when you're free.

vplasencia
vplasencia requested changes Nov 28, 2024
View reviewed changes
Copy link
Member

@vplasencia vplasencia left a comment

Choose a reason for hiding this comment

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

Hey @waddaboo great work! Very well explained. Thank you very much! I left some comments, please, feel free to share your ideas.

apps/docs/docs/tutorials/dashboard/groups.md Outdated Show resolved Hide resolved
apps/docs/docs/tutorials/dashboard/off-chain/multiple-credentials.md Outdated Show resolved Hide resolved
apps/docs/docs/tutorials/dashboard/manage.md Outdated Show resolved Hide resolved
apps/docs/docs/tutorials/dashboard/manage.md Outdated Show resolved Hide resolved
apps/docs/docs/tutorials/dashboard/manage.md Outdated Show resolved Hide resolved
apps/docs/docs/tutorials/dashboard/manage.md Outdated Show resolved Hide resolved
apps/docs/docs/tutorials/dashboard/manage.md Show resolved Hide resolved
apps/docs/docs/tutorials/api-sdk/credential-group.md Outdated Show resolved Hide resolved
apps/docs/docs/tutorials/api-sdk/credential-group.md Outdated Show resolved Hide resolved
@vplasencia vplasencia mentioned this pull request Nov 28, 2024
Closed
waddaboo and others added 6 commits November 28, 2024 22:45
@waddaboo @vplasencia
docs: update outdated info
080d475 
Co-authored-by: Vivian Plasencia <v.pcalana@gmail.com>
@waddaboo @vplasencia
docs: merge pointers
0f4e3df 
Co-authored-by: Vivian Plasencia <v.pcalana@gmail.com>
@waddaboo @vplasencia
docs: update wording
5921f8a 
Co-authored-by: Vivian Plasencia <v.pcalana@gmail.com>
@waddaboo @vplasencia
docs: update off-chain invite link to be more descriptive
f71a3e5 
Co-authored-by: Vivian Plasencia <v.pcalana@gmail.com>
@waddaboo @vplasencia
docs: update wording
71b2d9b 
Co-authored-by: Vivian Plasencia <v.pcalana@gmail.com>
@waddaboo @vplasencia
docs: update wording
0aea9e0 
Co-authored-by: Vivian Plasencia <v.pcalana@gmail.com>
waddaboo and others added 2 commits November 28, 2024 22:53
@waddaboo @vplasencia
docs: update wording
6b69c39 
Co-authored-by: Vivian Plasencia <v.pcalana@gmail.com>
@waddaboo @vplasencia
docs: update wording
f97459b 
Co-authored-by: Vivian Plasencia <v.pcalana@gmail.com>
@waddaboo
Copy link
Contributor Author

@vplasencia Hey! Thanks for the detailed review! I have updated the documentation according to your suggestions and have included the Client app part, but I'm not sure if it's what you're looking for.

Feel free to review whenever you're free and do let me know if any part still need any changes.

vplasencia
vplasencia requested changes Nov 29, 2024
View reviewed changes
apps/docs/docs/tutorials/api-sdk/credential-group.md Outdated Show resolved Hide resolved
apps/docs/docs/tutorials/api-sdk/credential-group.md Outdated Show resolved Hide resolved
apps/docs/docs/tutorials/api-sdk/credential-group.md Outdated Show resolved Hide resolved
apps/docs/docs/tutorials/api-sdk/credential-group.md Outdated Show resolved Hide resolved
@vplasencia
Copy link
Member

Could you also add to the tutorials in the Create and manage groups with API SDK page, the new function to generate the url for multiple credential groups?

@waddaboo waddaboo requested a review from vplasencia November 29, 2024 15:10
vplasencia
vplasencia requested changes Nov 29, 2024
View reviewed changes
Copy link
Member

@vplasencia vplasencia left a comment

Choose a reason for hiding this comment

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

It looks great! Thank you! Just one comments and the PR is ready to be merged.

apps/docs/docs/tutorials/api-sdk/groups.md Outdated Show resolved Hide resolved
@waddaboo waddaboo requested a review from vplasencia November 29, 2024 15:46
vplasencia
vplasencia approved these changes Nov 29, 2024
View reviewed changes
Copy link
Member

@vplasencia vplasencia left a comment

Choose a reason for hiding this comment

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

Great work @waddaboo 🚀

@vplasencia vplasencia merged commit 201ae8d into dev Nov 29, 2024
5 checks passed
@waddaboo waddaboo deleted the docs/tutorial branch November 29, 2024 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vplasencia vplasencia vplasencia approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@waddaboo @vplasencia