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 UG and README #461

Merged
merged 14 commits into from
Apr 12, 2020
Merged

Update UG and README #461

merged 14 commits into from
Apr 12, 2020

Conversation

johannagwan
Copy link

@johannagwan johannagwan commented Apr 11, 2020

Closes #460

Changes include:

  1. README
  • Remove export to PDF part
  1. UG
  • Command Legend: remove BODY part and make necessary changes
  • Paths: improve grammar, add symbols to title naming restrictions, fix typo in RelativePath
  • New: remove body, add symbols to title naming restrictions, TODO: update figma diagram to remove the body (can someone help do this?)
  • Edit: change "replace" to "update", change Format, will leave the more detailed changes for section 3.5.1 to @HemanshuGandhi (as stated in Notably v1.4 Deliverables (By 13-04) #380 )
  • Search: remove "coming in v2.0", move up to 3.7
  • Sug: change TAB to ENTER, add coming in v2.0 for paths that include ../
  • Command Summary: update new and edit format

Can someone help change in all the figma diagrams, from "Press tab to autofill" to "Press enter to autofill"? @HemanshuGandhi @ljiazh3ng @firzanarmani @kevinputera

@johannagwan johannagwan added priority.High Must do type.Enhancement An enhancement to an existing story labels Apr 11, 2020
@johannagwan johannagwan added this to the v1.4 milestone Apr 11, 2020
@johannagwan johannagwan requested a review from a team April 11, 2020 19:30
@johannagwan johannagwan self-assigned this Apr 11, 2020
@netlify
Copy link

netlify bot commented Apr 11, 2020

Deploy preview for notably-app ready!

Built with commit 877b5bd

https://deploy-preview-461--notably-app.netlify.com

@codecov
Copy link

codecov bot commented Apr 11, 2020

Codecov Report

Merging #461 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #461   +/-   ##
=========================================
  Coverage     67.35%   67.35%           
  Complexity      591      591           
=========================================
  Files           100      100           
  Lines          2359     2359           
  Branches        227      227           
=========================================
  Hits           1589     1589           
  Misses          693      693           
  Partials         77       77           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0b00be9...53de00d. Read the comment docs.

@netlify
Copy link

netlify bot commented Apr 11, 2020

Deploy preview for notably-app ready!

Built with commit 53de00d

https://deploy-preview-461--notably-app.netlify.com

Copy link

@kevinputera kevinputera left a comment

Choose a reason for hiding this comment

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

@johannagwan thanks for the initiative! I have left some comments, what do you think? Otherwise, LTGM!

docs/UserGuide.adoc Outdated Show resolved Hide resolved
docs/UserGuide.adoc Outdated Show resolved Hide resolved
docs/UserGuide.adoc Show resolved Hide resolved
docs/UserGuide.adoc Outdated Show resolved Hide resolved
@johannagwan johannagwan merged commit 931297a into master Apr 12, 2020
@johannagwan johannagwan deleted the update-ug branch April 12, 2020 06:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority.High Must do type.Enhancement An enhancement to an existing story
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update UG and Readme
2 participants