Improve doveadm documentation #1108
Merged
Conversation
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
slusarz
force-pushed
the
doveadm_examples
branch
from
8bb1bcd to
8264e6c
Compare
This comment has been minimized.
This comment has been minimized.
slusarz
force-pushed
the
doveadm_examples
branch
from
8264e6c to
76c8f3c
Compare
cmouse
reviewed
Dec 18, 2024
These example arguments will be used for building example command/HTTP queries
Dynamically generate this data only when the user clicks on the API documentation for a command, otherwise we are creating giant pages which will noticeably slowdown browsing. Additionally, add the command name to the HTTP output as well, since that was previously missing (although it can be found in the request example, it is not clearly labeled there).
Namely, hide under a clickable element, so user only sees the doveadm mode they need after clicking.
The old 'fields' entry in data/doveadm.js has been replaced with the 'response' entry. This new entry allows for text description and data type output. Output example JSON server response in the HTTP API block.
cmouse
force-pushed
the
doveadm_examples
branch
from
76c8f3c to
25e850c
Compare
cmouse
approved these changes
Dec 20, 2024
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.
DOV-7017
Still have to do all the hardwork of adding the various examples and response data to doveadm.js... But don't want to wait for that since it's not necessary for adding this base functionality.
(FYI: I already have done some work on the examples data, so maybe I'll throw that in a WIP MR for now.)