update docs for account api tokens [LK-1497]#2427
Merged
joanasteodoro merged 1 commit intoJul 14, 2025
Merged
Conversation
Contributor
|
Overall readability score: 53.05 (🟢 +0.01)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
82cbc00 to
267e666
Compare
267e666 to
94ab18e
Compare
94ab18e to
9b914b5
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the account API tokens documentation by clarifying expiration settings, adding updated screenshots, and aligning the delete workflow.
- Added instructions for selecting expiration dates (7–90 days, custom, or none).
- Introduced new screenshots for the creation modal and tokens table.
- Updated language from “revoke” to “delete” and reflected the trash icon in the UI instructions.
Comments suppressed due to low confidence (3)
docs/codacy-api/api-tokens.md:32
- [nitpick] This step is still numbered '1.' after the initial '1.' above. Consider numbering it '2.' to clearly indicate the next step.
1. Select an expiration date from the modal options. You can select between a range of 7 days to 90 days, create a custom expiration date, or create a token with no expiration.
docs/codacy-api/api-tokens.md:32
- [nitpick] The phrase 'between a range of 7 days to 90 days' is a bit wordy. Consider rephrasing to 'between 7 and 90 days' for clarity.
1. Select an expiration date from the modal options. You can select between a range of 7 days to 90 days, create a custom expiration date, or create a token with no expiration.
docs/codacy-api/api-tokens.md:39
- The tip still uses 'revoking' but the main action is now 'deleting'. For consistency, update this to 'deleting' only the specific token.
You can create multiple account API tokens. This can be useful to have a more flexible control by revoking only a specific token.
andrzej-janczak
approved these changes
Jul 14, 2025
Contributor
andrzej-janczak
left a comment
There was a problem hiding this comment.
LGTM
thanks for the doc update @joanasteodoro 💯
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
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.
👀 Live preview
🚧 To do