Skip to content

docs: Improve UG #291

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

Merged

Conversation

tituschewxj
Copy link
Member

@tituschewxj tituschewxj commented Apr 12, 2024

Let's

  • use newPage and newPageBetween variable
  • Remove redundant note/tip label
  • Use keyFormat for keys
  • Add whitespace
  • Add semi-bold font
  • Add parameter to recognized prefix
  • Wrap prefixes in code
  • Add keyboard input to symbols
  • Add icons
  • Update NUSNet ID to uppercase
  • Format box for command
  • Update tables
  • Add box for command format
  • Update boxes

See TAPro - User Guide.pdf

Resolves: #247, resolves #237

@tituschewxj tituschewxj added size.medium Formidable sized pr, less than 500 lines of code changed type.ug User guide labels Apr 12, 2024
@tituschewxj tituschewxj added this to the v1.4 milestone Apr 12, 2024
@tituschewxj tituschewxj self-assigned this Apr 12, 2024
Let's
* use newPage variable
* Remove redundant note/tip label
* Use keyFormat for keys
* Add whitespace
* Add semi-bold font
* Add parameter to recognized prefix
* Wrap prefixes in code
* Add keyboard input to symbols
* Add icons
* Update NUSNet ID to uppercase
* Format for command
* Update tables
* Add box for command format
* Update boxes
Copy link

@belligerentbeagle belligerentbeagle left a comment

Choose a reason for hiding this comment

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

This is such a big improvement to our UG, thanks for doing this.

Future enhancement include clicking <span class="badge bg-light text-dark"><i class="fa-regular
fa-square-caret-right"></i> RIGHT</span> key to move the cursor to
the front of the command.
Future enhancements include pressing the {{ macros.keyFormat('Right', '<i class="fa-regular fa-square-caret-right"></i>') }} key to move the cursor to

Choose a reason for hiding this comment

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

Great addition!

Copy link

@wxiaoyun wxiaoyun left a comment

Choose a reason for hiding this comment

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

Thanks a lot for making the formating consistent and fixing some of the ug bugs. LGTM!

@wxiaoyun wxiaoyun merged commit b4e7faa into AY2324S2-CS2103T-F13-1:master Apr 13, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority.high !!! size.medium Formidable sized pr, less than 500 lines of code changed type.ug User guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change NUSNET_ID to NUSNET Change e1234567 to E1234567 in docs
3 participants