fix-for-documentation-to-match-latest-development

[Manik-Khajuria-5]

Summary

Implemented the documentation part for issue #17.

What is done

• Added/updated documentation for check-in flow
• Improved clarity and structure
• Covered expected usage and behavior

Pending / Blockers

• The REST implementation is currently blocked due to unclear device registration flow.
• Specifically, I am unable to determine how QR codes are generated and used for device registration in the check-in system.
• This affects how the API should handle registration and validation of devices.

What I have tried

• Explored the existing codebase for QR/device registration logic
• Investigated Visdom integration related to this flow
• Reached out on the Visdom mailing list and discussed with maintainers

Request

• Guidance on how device registration via QR is expected to work

Next Steps

• Once clarification is received, I will complete the REST part
• Happy to take guidance from maintainers if there's an alternative approach

Additional Context

This PR is opened to share progress and get early feedback.

Summary by Sourcery

Update user-facing documentation to clarify check-in and exhibitor login workflows.

Documentation:

• Clarified wording and role selection instructions in the check-in workflow documentation.
• Improved exhibitor workflow documentation to better describe the login step.

[netlify]

✅ Deploy Preview for eventyay-checkin ready!

Name	Link
🔨 Latest commit	0426bec
🔍 Latest deploy log	https://app.netlify.com/projects/eventyay-checkin/deploys/69dfa766281e0100086b950b
😎 Deploy Preview	https://deploy-preview-71--eventyay-checkin.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Documentation for the check-in and exhibitor workflows has been updated to better match the current UI/wording, improving clarity and consistency of instructions.

File-Level Changes

Change	Details	Files
Refine check-in workflow documentation wording to align with current login UI and terminology.	Clarified Step 1 instructions by adding comma, using lowercase for 'page', and specifying 'select a Server' and 'click I am a Checkin Staff' Standardized wording by changing 'check-in' to 'checkin' in the Step 5 description while keeping behavior the same	docs/checkin.md
Improve exhibitor workflow login step wording for clarity and correct grammar.	Updated Step 1 instructions to include comma after 'Login page', lowercase 'server', and grammatically correct label 'I am an Exhibitor'	docs/exhibitor.md

Possibly linked issues

• Update documentation to match latest development #17: They address the same documentation update: adjusting login step text and checkin wording to current behavior.
• Update documentation to match latest development #17: PR updates check-in and exhibitor workflow documentation, directly fulfilling the documentation request described in the issue.

---

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. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard 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 for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've found 3 issues, and left some high level feedback:

• The terminology for the flow varies between CheckIn, checkin, and check-in; consider standardizing this throughout the docs for consistency.
• In the updated step descriptions, review capitalization of common nouns like 'server' and 'login page' to align with the rest of the documentation style.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The terminology for the flow varies between `CheckIn`, `checkin`, and `check-in`; consider standardizing this throughout the docs for consistency.
- In the updated step descriptions, review capitalization of common nouns like 'server' and 'login page' to align with the rest of the documentation style.

## Individual Comments

### Comment 1
<location path="docs/checkin.md" line_range="3" />
<code_context>
 # CheckIn Workflow

-**Step 1:** In the Login page Select Server and role `I am a Checkin-Staff`
+**Step 1:** In the Login page, select a Server and click `I am a Checkin Staff`
 <img src="./images/login.png" alt="Login Page">

</code_context>
<issue_to_address>
**suggestion (typo):** Consider improving the phrasing of "In the Login page" and verifying the spelling of "Checkin Staff".

You could update this line to something like: `**Step 1:** On the login page, select a server and click "I am a check-in staff"`. Also, please confirm the button label in the UI uses the same spelling and hyphenation as in the docs.

Suggested implementation:

```
**Step 1:** On the login page, select a server and click `I am a check-in staff`

```

1. Verify the actual label text of the button in the UI. If it differs (e.g., "I am a Checkin-Staff", "I am a Check-in Staff", etc.), update either the UI or this doc so they match exactly.
2. Search the rest of the docs for "Checkin Staff" / "Check-in staff" and standardize the spelling and hyphenation.
</issue_to_address>

### Comment 2
<location path="docs/checkin.md" line_range="15" />
<code_context>
 <img src="./images/checkin.png" alt="Checkin">

-**Step 5:** Once a check-in is done a popup will appear to show the details of the checked-in attendee, with the option to generate a badge
+**Step 5:** Once a checkin is done a popup will appear to show the details of the checked-in attendee, with the option to generate a badge
 The Badge can be generated by clicking the `Generate Badge` button
 <img src="./images/info.png" alt="Attendee Info">
</code_context>
<issue_to_address>
**suggestion (typo):** Add a comma after the introductory clause and hyphenate "check-in" for consistency.

You could revise this to: "Once a check-in is done, a popup will appear to show the details of the checked-in attendee, with the option to generate a badge."

```suggestion
**Step 5:** Once a check-in is done, a popup will appear to show the details of the checked-in attendee, with the option to generate a badge
```
</issue_to_address>

### Comment 3
<location path="docs/exhibitor.md" line_range="3" />
<code_context>
 # Exhibitor Workflow

-**Step 1:** In the Login page Select Server and role `I am a Exhibitor`
+**Step 1:** In the Login page, select a Server and click `I am an Exhibitor`
 <img src="./images/login.png" alt="Login Page">

</code_context>
<issue_to_address>
**suggestion (typo):** Consider rephrasing "In the Login page" to the more idiomatic "On the login page".

You could rewrite this as: "On the login page, select a server and click `I am an Exhibitor`." This uses the more natural preposition "on" and standard capitalization unless those terms match specific UI labels.

```suggestion
**Step 1:** On the login page, select a server and click `I am an Exhibitor`.
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion (typo): Consider improving the phrasing of "In the Login page" and verifying the spelling of "Checkin Staff".

You could update this line to something like: **Step 1:** On the login page, select a server and click "I am a check-in staff". Also, please confirm the button label in the UI uses the same spelling and hyphenation as in the docs.

Suggested implementation:

**Step 1:** On the login page, select a server and click `I am a check-in staff`

1. Verify the actual label text of the button in the UI. If it differs (e.g., "I am a Checkin-Staff", "I am a Check-in Staff", etc.), update either the UI or this doc so they match exactly.
2. Search the rest of the docs for "Checkin Staff" / "Check-in staff" and standardize the spelling and hyphenation.

[Manik-Khajuria-5]

@mariobehling Hi , I wanted clarification how do qr based device registration in eventyay Can u please help me to figure it out ?