Skip to content

Commit

Permalink
Update User Guide for Enhanced Clarity and User Engagement
Browse files Browse the repository at this point in the history
This commit overhauls the FriendFolio User Guide to improve user
engagement and provide a clearer understanding of the app's features.
Key updates include:

1. Introduction of a new section, 'What is FriendFolio?', offering a
 comprehensive description of the app's purpose and key
 functionalities.
2. Revision of the 'Getting Started' section to streamline the
 installation and setup instructions for better user experience.
3. Expansion of the 'Command Overview' section with detailed
 explanations of each command, including parameter prefixes
 and usage examples.
4. Enhancement of the user guide's overall tone to be more friendly
 and inviting, aligning with FriendFolio's community-focused brand.
5. Addition of a 'Coming Soon in v2.0' section to preview upcoming
 features and improvements, building anticipation among users.

These changes aim to make the guide more intuitive and helpful,
ensuring users can fully leverage FriendFolio to enhance their
social and academic interactions.
  • Loading branch information
NewtonKoh committed Apr 15, 2024
1 parent c640c48 commit b9c50a7
Show file tree
Hide file tree
Showing 11 changed files with 415 additions and 148 deletions.
11 changes: 4 additions & 7 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,12 @@ GEM
http_parser.rb (~> 0)
ethon (0.16.0)
ffi (>= 1.15.0)
eventmachine (1.2.7)
eventmachine (1.2.7-x64-mingw32)
execjs (2.8.1)
faraday (2.7.5)
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2)
ffi (1.15.5)
ffi (1.15.5-x64-mingw32)
forwardable-extended (2.6.0)
gemoji (3.0.1)
Expand Down Expand Up @@ -207,14 +205,12 @@ GEM
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
mini_portile2 (2.8.5)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.19.0)
nokogiri (1.16.2)
mini_portile2 (~> 2.8.2)
nokogiri (1.16.2-x64-mingw32)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
Expand Down Expand Up @@ -249,9 +245,9 @@ GEM
concurrent-ruby (~> 1.0)
unf (0.1.4)
unf_ext
unf_ext (0.0.8.2)
unf_ext (0.0.8.2-x64-mingw32)
unicode-display_width (1.8.0)
wdm (0.1.1)
webrick (1.8.1)

PLATFORMS
Expand All @@ -261,7 +257,8 @@ PLATFORMS
DEPENDENCIES
github-pages
jekyll
wdm (~> 0.1.0)
webrick

BUNDLED WITH
2.1.4
2.2.33
535 changes: 400 additions & 135 deletions docs/UserGuide.md

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/_sass/minima/_layout.scss
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

&,
&:visited {
color: $brand-color-dark;
color: white;
}
}

Expand Down Expand Up @@ -74,7 +74,7 @@
}

.page-link {
color: $text-color;
color: white;
line-height: $base-line-height;
display: block;
padding: 5px 10px;
Expand All @@ -86,6 +86,7 @@
margin-left: 20px;
}


@media screen and (min-width: $on-medium) {
position: static;
float: right;
Expand Down Expand Up @@ -176,8 +177,8 @@
.post-content {
margin-bottom: $spacing-unit;

h1, h2, h3 { margin-top: $spacing-unit * 2 }
h4, h5, h6 { margin-top: $spacing-unit }
h1, h2, h3 { margin-top: $spacing-unit }
h4, h5, h6 { margin-top: $spacing-unit / 2 }

h2 {
@include relative-font-size(1.75);
Expand Down
4 changes: 2 additions & 2 deletions docs/_sass/minima/custom-styles.scss
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Placeholder to allow defining custom styles that override everything else.
// (Use `_sass/minima/custom-variables.scss` to override variable defaults)
h2, h3, h4, h5, h6 {
color: #e46c0a;
h1, h2, h3, h4, h5, h6 {
color: #0a7873;
}

// Bootstrap style alerts
Expand Down
4 changes: 4 additions & 0 deletions docs/assets/css/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@
height: 21px;
width: 21px
}

.site-header {
background: linear-gradient(90deg, rgba(17,64,83,1) 0%, rgba(9,121,114,1) 43%, rgba(0,212,255,1) 100%);
}
Binary file added docs/images/CommandResult.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/DisplayCard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/JarFile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Signature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/UiBreakdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b9c50a7

Please sign in to comment.