Skip to content

fix: gen-jwt command guide fixed (en)#168

Merged
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
aliozinan:fix-gen-jwt-command-guide-en
Sep 30, 2025
Merged

fix: gen-jwt command guide fixed (en)#168
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
aliozinan:fix-gen-jwt-command-guide-en

Conversation

@aliozinan
Copy link
Copy Markdown
Contributor

@aliozinan aliozinan commented Sep 30, 2025

Description

The command inside the Database Guides > Self-hosted libSQL server > Generate your JWT token section is throwing an error, with the reason that the -e parameter should come before the key file path.

Summary by CodeRabbit

  • Documentation
    • Updated the sqld-server guide to reflect the correct command syntax for generating JWTs, placing the expiration flag before the private key argument.
    • Clarified the example invocation to improve readability and reduce potential confusion when copying commands.
    • Ensured consistency across documentation by aligning argument order with recommended usage.
    • No behavioral changes to tooling implied; this is a documentation-only update.

-e parameter needs to be typed before the key file path
@aliozinan aliozinan requested a review from a team as a code owner September 30, 2025 20:16
@netlify
Copy link
Copy Markdown

netlify Bot commented Sep 30, 2025

Deploy Preview for studiocms-dev-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 5e60e4e
🔍 Latest deploy log https://app.netlify.com/projects/studiocms-dev-docs/deploys/68dc3aa985b091000837eb76
😎 Deploy Preview https://deploy-preview-168--studiocms-dev-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 30, 2025

📝 Walkthrough

Walkthrough

Reorders arguments in a command example within the sqld-server documentation, placing the -e 31556926 flag before the private key path. No functional or control-flow changes.

Changes

Cohort / File(s) Summary
Docs — sqld server guide
src/content/docs/en/guides/database/sqld-server.mdx
Updated command example: moved -e 31556926 before "../keys/libsql.pem" in crypto gen-jwt invocation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A bunny taps the keys—so fleet, so neat,
Swaps a flag’s small seat to make it sweet.
The docs now hop in tidy rows,
With JWT in proper clothes.
Carrot raised: “Ship it!”—complete. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title clearly indicates that the pull request fixes the gen-jwt command guide, matching the core change of reordering the -e flag in the documentation; it is concise, specific to the guide, and immediately informs readers of the key correction.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 652c7e9 and 5e60e4e.

📒 Files selected for processing (1)
  • src/content/docs/en/guides/database/sqld-server.mdx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - studiocms-dev-docs
  • GitHub Check: Header rules - studiocms-dev-docs
  • GitHub Check: Pages changed - studiocms-dev-docs
🔇 Additional comments (1)
src/content/docs/en/guides/database/sqld-server.mdx (1)

55-55: Command order fix looks good

Placing -e 31556926 before the key path aligns with the CLI’s expected flag ordering and prevents the command from failing. Nice catch.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@studiocms-no-reply
Copy link
Copy Markdown
Member

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/database/sqld-server.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Copy Markdown
Member

@dreyfus92 dreyfus92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you @aliozinan

@Adammatthiesen Adammatthiesen merged commit db87086 into withstudiocms:main Sep 30, 2025
12 checks passed
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Sep 30, 2025
Adammatthiesen pushed a commit that referenced this pull request Sep 30, 2025
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.

4 participants