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

Commenting on text #124

Open
aronmolnar opened this issue Oct 27, 2023 · 1 comment
Open

Commenting on text #124

aronmolnar opened this issue Oct 27, 2023 · 1 comment
Labels
in progress 🚩 milestone roadmap-H1-2024 Roadmap for the first half of 2024

Comments

@aronmolnar
Copy link
Contributor

We currently allow users to use the keyword "TODO" for writing remarks on text. SysReptor counts those TODOs and displays a warning.

image

It would be nice to allow comments as metadata (also receiving this regularly as customer feedback) . I looked at notion how they solved this.

They allow selecting the text and select "comment" via a menu bar (we could add this to the markdown editor's menu bar).
image

The comment can then be written into an overlay text box.

image

They then display a comment symbol and the number of comments (and replies) in this line at the right hand side.

image

The comment contains the referenced text (this is a static reference - if you delete "Number 1", the comment remains the same) and a thread of comments.

image

To limit complexity of this we might want to limit this functionality to markdown fields.

@aronmolnar aronmolnar added the roadmap-H1-2024 Roadmap for the first half of 2024 label Dec 21, 2023
@Moneysac90
Copy link

However, you can not apply a comment to the current text as implemented in word.

image

As you can see in the picture above a user can click on "annehmen" (german for apply). A reviewer can therefore write some text he assumes to be better and the tester can choose to apply it. This is important in some cases since the reviewer is missing context from the pentest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in progress 🚩 milestone roadmap-H1-2024 Roadmap for the first half of 2024
Projects
None yet
Development

No branches or pull requests

3 participants