fossasia / eventyay-checkin

eventyay checkin
https://access.eventyay.com
Apache License 2.0
1.46k stars 14 forks source link

Add Documentation #14

Closed Sak1012 closed 4 weeks ago

Sak1012 commented 4 weeks ago

This PR resolves #11 by adding documentation explaining exhibitors and event staff workflow

Summary by Sourcery

Add documentation for the CheckIn and Exhibitor workflows, providing detailed steps and images to guide event staff and exhibitors through their respective processes.

Documentation:

sourcery-ai[bot] commented 4 weeks ago

Reviewer's Guide by Sourcery

This PR adds new documentation files that explain the workflows for exhibitors and check-in staff. The documentation includes step-by-step guides with screenshots for both user roles, detailing the process from login to their respective main functionalities.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added documentation for check-in staff workflow
  • Documented login and device authentication process
  • Added event selection instructions
  • Detailed check-in process with camera usage
  • Explained badge generation and printing workflow
docs/checkin.md
Added documentation for exhibitor workflow
  • Documented login and device authentication process
  • Added event selection and auth key instructions
  • Detailed lead scanning functionality
  • Explained lead management features including tags and notes
  • Added information about downloading leads as CSV
docs/exhibitor.md

Assessment against linked issues

Issue Objective Addressed Explanation
#11 Add documentation for the Exhibitor workflow in the Checkin App
#11 Add documentation for the Check-in workflow in the Checkin App

Possibly linked issues


Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).