docs(contributing): basic fixes#1418
Merged
Merged
Conversation
Signed-off-by: Alex C-G <alexcg@outlook.com>
Signed-off-by: Alex C-G <alexcg@outlook.com>
Signed-off-by: Alex C-G <alexcg@outlook.com>
samsja
reviewed
Apr 18, 2023
Comment on lines
338
to
344
| #### [MyST](https://myst-parser.readthedocs.io/en/latest/) Elements Usage | ||
|
|
||
| 1. Use the `{tab}` element to show multiple ways of doing one thing. [Example](https://docarray.jina.ai/fundamentals/document/#document) | ||
| 2. Use the `{admonition}` boxes with care. | ||
| 3. Use `{dropdown}` to hide optional content, such as long code snippets or console output. | ||
|
|
||
|
|
||
| Note: Example code in the documentation should also follow our [code style conventions](). |
Member
There was a problem hiding this comment.
you u remove this section. it is not relevant anymore as we don't use myst
Contributor
Author
There was a problem hiding this comment.
Roger that. What about the [code style conventions]()? There's no URL
Member
There was a problem hiding this comment.
you can remove the link, lets just say follow our code style
samsja
reviewed
Apr 18, 2023
samsja
reviewed
Apr 18, 2023
samsja
reviewed
Apr 18, 2023
samsja
requested changes
Apr 18, 2023
samsja
left a comment
Member
There was a problem hiding this comment.
need to change some part about mkdocs
Co-authored-by: samsja <55492238+samsja@users.noreply.github.com> Signed-off-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Signed-off-by: Alex C-G <alexcg@outlook.com>
|
📝 Docs are deployed on https://ft-docs-contributing-fix--jina-docs.netlify.app 🎉 |
samsja
approved these changes
Apr 18, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
General tidy up
Signed-off-by: Alex C-G alexcg@outlook.com