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

Add a doc about the Custom Javadoc Tags feature #1085

Merged
merged 4 commits into from
Nov 2, 2022
Merged

Conversation

onewhl
Copy link
Member

@onewhl onewhl commented Oct 4, 2022

Description

Add a doc about the Custom Javadoc Tags feature.

Type of Change

  • New documentation

Checklist (remove irrelevant options):

  • New documentation is provided or existed one is altered
  • All tests pass locally with my changes

@olganaumenko
Copy link
Collaborator

@onewhl, please find the screenshots below :)

settings-example

settings-example-2

Screenshot (28)

Screenshot (29)

Screenshot (27)

Screenshot (26)

Screenshot (32)

Screenshot (30)

Screenshot (33)

Screenshot (31)

@onewhl
Copy link
Member Author

onewhl commented Oct 4, 2022

@korifey there are some screenshots and I'm not sure if it's ok to add them to repository. Where can we store them?

@amandelpie
Copy link
Collaborator

amandelpie commented Oct 4, 2022

@korifey there are some screenshots and I'm not sure if it's ok to add them to repository. Where can we store them?

IMHO, we could a subfolder images in docs and them there if they are enough small

Or it should be located in the Readme of project or in Wiki

@onewhl
Copy link
Member Author

onewhl commented Oct 6, 2022

@amandelpie each image is about 50Kb. It would be awesome to store images on some server and add links to the images to the doc. So, they would be rendered in markdown correctly and won't occupy space in the repository.

@onewhl onewhl marked this pull request as ready for review October 7, 2022 18:35
@amandelpie
Copy link
Collaborator

@korifey could please have a look and approve

@amandelpie
Copy link
Collaborator

@korifey please have a look, need to merge it

@amandelpie amandelpie merged commit 4398ff2 into main Nov 2, 2022
@amandelpie amandelpie deleted the zarina/doc branch November 2, 2022 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants