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

Update user workflow #12

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

Update user workflow #12

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b4b5e66
Add description of main features
Arif-Khalid Feb 10, 2024
0de5b36
Add image to user workflow
Arif-Khalid Feb 11, 2024
ef97d0b
Fix numbering error and update image
Arif-Khalid Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions css/main.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ mark {
padding-bottom: 0;
}

.center{
display: flex;
justify-content: center;
}

.indented {
padding-left: 20px;
}
Expand Down
11 changes: 11 additions & 0 deletions dg/user-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,14 @@
# User workflow

<!-- Add relevant content -->
## Overview

![](../images/user-workflow.png) {.center}

Here is a brief explanation of each of its main features
1. **Issue viewer**
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.
Copy link

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 •
edited
Loading

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.

2. **Activity dashboard** (Not in production yet)
1. Users can navigate to the activity dashboard through the page selection located on the top left.
1. They will be able to see more details about their repository. (Specifics still in development)
Binary file added images/user-workflow.png
View file
Open in desktop
Copy link

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.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.