The numbers, e.g. 1.1, 3, 3.1, refers to the sections in our UG
[x] KEVIN General: Update mockups to reflect newest changes
[ ] EVERYONE General: Add more FAQ
[ ] EVERYONE General: Change all occurrence of Block -> Note
[x] KEVIN 1.1: Add an additional arrow for the response text area, i.e. the field with the text "open a note"
[ ] HEMANSHU 1.1: I feel like we can add more explanations to the parts we highlighted in the mockup. For example, we can explain that command input box is the place where all interactions happen, etc.
[ ] 1.2: To be honest, I find the difference between the information symbol and the lightbulb symbol subtle. Will it work if we just use one of them?
[ ] 2: Let's link notably.jar to our release page
[x] JIA ZHENG 3 (Paths): I think the line "specify the directory you want Commands to be executed" is a bit misleading, because it's not the case for delete commands, for example. Perhaps we can rephrase it?
[x] JIA ZHENG 3 (Paths): Add description that AbsolutePath starts with "/"
[x] JIA ZHENG 3 (Paths): I think when explaining relative paths, we should avoid using the term "move to ..." because that might not be the case. Instead, consider rephrasing it as "point to ..."?
[x] JIA ZHENG 3 (Paths): Do y'all think it's easier for the user to understand the illustration if it's drawn on top of our app directly, rather than the current tree drawing?
[x] JIA ZHENG 3 (Paths): I noticed that in some places we write Relative Path, while in some other places we write RelativePath. Let's make it consistent?
[x] JIA ZHENG 3 (Paths): Let's rephrase "current working directory" as "currently opened note"? In a way, these two terms refer to the same thing and using both at the same time might be confusing.
[x] JIA ZHENG 3 (Paths): Let's explain about the validity of paths (what kind of characters are allowed) and about case-insensitiveness of paths?
[x] KEVIN 3 (Markdown): I'm gonna reduce the amount of information here, and instead move most of the content (+ additional explanations) to a separate feature section.
[x] HEMANSHU 3.1: Rephrase as "a list of commands + a link to our DG", since @hemanshu is already working on a PR that displays the list of commands.
[x] FIRZAN 3.3: Let's remove the term "current working directory" and just use the term "currently opened note"?
[x] FIRZAN 3.3: Let's talk about the case-insensitiveness of title?
[x] FIRZAN 3.3: Let's talk about duplicate blocks?
[x] HEMANSHU3.4: Would it be better if we rephrase [PATH/TO/]TITLE as RelativePath/AbsolutePath? It'll nicely link back to @jiazheng's explanation too
[x] HEMANSHU3.4: Let's talk about opening root?
[x] HEMANSHU3.5: Put a newline before the Format: edit line
[x] HEMANSHU 3.5: Update the demo for edit command to include the new edit modal
[x] FIRZAN 3.6: Similar to open command, should we rephrase [PATH/TO/]TITLE as AbsolutePath/RelativePath?
[x] FIRZAN 3.6: Let's write about deleting the currently opened note (delete .) and deleting parents of the currently opened note (delete .., delete ../.., etc)
[x] FIRZAN 3.6: Let's talk about deleting root?
[x] JOHANNA 3.7: I feel like we could use more explanation here. For example, what do we mean by "a note that contain a specific keyword"? Is the title included? Another example, what do we mean by partial matches?
[x] JOHANNA 3.7: The demo command search -s Computer science is not properly highlighted
[x] FIRZAN 3.8: Let's add more explanation here? For example, we can talk about what kind of data is persisted (currently opened note, the whole blocktree, window size, etc)
[x] JOHANNA 3.9: I feel like we should add more demo mockups here. We should display what we mean by auto completion, for example.
[x] JOHANNA 3.9: I feel like we can use more explanation in this section. How to navigate through the suggestions list, for example (using the arrow keys)?
[x] KEVIN 3.10: I'll provide more explanation here
[x] KEVIN 3.11 (New section): I'll talk about markdown here, in this section
[x] JOHANNA 3.12 (New section): Let's talk about response text? How it's used to display error messages + response as user types
[x] FIRZAN 3.13 (New section): Let's talk about our sidebar? How it only shows 3 levels, how is the behaviour of the expansion, etc.
The numbers, e.g. 1.1, 3, 3.1, refers to the sections in our UG
Block
->Note
notably.jar
to our release pageCommands
to be executed" is a bit misleading, because it's not the case fordelete
commands, for example. Perhaps we can rephrase it?AbsolutePath
starts with "/"Relative Path
, while in some other places we writeRelativePath
. Let's make it consistent?[PATH/TO/]TITLE
asRelativePath/AbsolutePath
? It'll nicely link back to @jiazheng's explanation tooedit
lineedit
command to include the new edit modalopen
command, should we rephrase[PATH/TO/]TITLE
asAbsolutePath/RelativePath
?delete .
) and deleting parents of the currently opened note (delete ..
,delete ../..
, etc)search -s Computer science
is not properly highlighted