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

Update user workflow #12

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Arif-Khalid
Copy link

@Arif-Khalid Arif-Khalid commented Feb 11, 2024

Summary:

Fixes #6

Changes Made:

  • Added a simple user workflow with a diagram

Screenshots:

image

Proposed Commit Message:

User workflow is missing.

User workflow is important for developers to understand the
product for more productive contributions.

Let's add a simple user workflow.

Copy link

@cheehongw cheehongw left a comment

Choose a reason for hiding this comment

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

I have not personally built the docs, so I can't tell how it looks but it will be great to include a screenshot in your PR to help with the review process.

Especially with changes such as adding an image.

Comment on lines 18 to 19
1. Users will first see the issue viewer when watching a github repo with WATcher.
1. They can sort and filter by various parameters such as titles, milestones and labels.

Choose a reason for hiding this comment

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

The sub-bullet points seem to be wrongly numbered

Copy link
Author

Choose a reason for hiding this comment

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

I numbered them this way following the convention of CATcher docs which writes all bullet points as 1., letting markbind handle the appropriate numbering.
If this is unintentional it should be made an issue in CATcher docs.
image

Copy link
Author

@Arif-Khalid Arif-Khalid Mar 5, 2024

Choose a reason for hiding this comment

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

For now I have fixed the numbering in this PR.

Choose a reason for hiding this comment

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

personally i find the smiley face too ... artistic.

would prefer a cleaner design, perhaps something consistent w CATcher docs for a more professional look.

image

Also, arranging this image in landscape mode may help w the readability of the website

Copy link
Author

Choose a reason for hiding this comment

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

Agreed.
I have updated the image following your guidelines, please find the updated diagram in the updated PR summary.

@Arif-Khalid Arif-Khalid requested a review from cheehongw March 5, 2024 14:14
Copy link

@NereusWB922 NereusWB922 left a comment

Choose a reason for hiding this comment

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

LGTM!

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

Successfully merging this pull request may close these issues.

User Workflow to be updated
3 participants