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.

Sign up for GitHub

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

Jump to bottom

Integrate markdown editor for task documentation #287

Closed
nmanovic opened this issue Jan 18, 2019 · 0 comments · Fixed by #6191
Closed

Integrate markdown editor for task documentation #287

nmanovic opened this issue Jan 18, 2019 · 0 comments · Fixed by #6191
Assignees
@nmanovic
Labels
enhancement New feature or request

Comments

@nmanovic
Copy link
Contributor

Internally we try to create for each annotation task a specification in markdown format (aka requirements for annotations). Usually it should be submitted to git repository together with annotations. It will be great to integrate "creating" such documentation directly into CVAT using https://github.com/benweet/stackedit JS library (or similar library).

In git repository isn't setup it is possible to save it directly into "task" directory. StackEdit library allows to export such specification in PDF format.

Probably it should be implemented when our "client" part will be implemented using nodejs.
@nmanovic nmanovic added enhancement New feature or request good first issue labels Jan 18, 2019
@nmanovic nmanovic added this to the Backlog milestone Jan 18, 2019
@nmanovic nmanovic self-assigned this Jan 18, 2019
@nmanovic nmanovic removed this from the Backlog milestone Nov 28, 2021
@bsekachev bsekachev mentioned this issue Jan 17, 2023
Closed
@bsekachev bsekachev mentioned this issue May 30, 2023
Merged
7 tasks
bsekachev added a commit that referenced this issue Jun 23, 2023
@bsekachev
Markdown documentation for tasks/projects (#6191)
307db39 
<!-- Raise an issue to propose your change
(https://github.com/opencv/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution
guide](https://opencv.github.io/cvat/docs/contributing/). -->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
<img width="1130" alt="image"
src="https://github.com/opencv/cvat/assets/40690378/3c1b767d-2aa2-474b-af1e-1fc02d8c359d">
<img width="1133" alt="image"
src="https://github.com/opencv/cvat/assets/40690378/fdf6115a-e88d-4da6-83fb-c9fddd871e49">
<img width="1920" alt="image"
src="https://github.com/opencv/cvat/assets/40690378/f6e97db5-84cb-4c1e-9b2a-82eca633a79c">

Resolved #287
Resolved #3680
Resolved #5580

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [x] I submit my changes into the `develop` branch
- [x] I have added a description of my changes into the
[CHANGELOG](https://github.com/opencv/cvat/blob/develop/CHANGELOG.md)
file
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [x] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
- [x] I have increased versions of npm packages if it is necessary

([cvat-canvas](https://github.com/opencv/cvat/tree/develop/cvat-canvas#versioning),

[cvat-core](https://github.com/opencv/cvat/tree/develop/cvat-core#versioning),

[cvat-data](https://github.com/opencv/cvat/tree/develop/cvat-data#versioning)
and

[cvat-ui](https://github.com/opencv/cvat/tree/develop/cvat-ui#versioning))

### License

- [x] I submit _my code changes_ under the same [MIT License](
https://github.com/opencv/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nmanovic nmanovic

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Markdown documentation for tasks/projects cvat-ai/cvat
1 participant
@nmanovic